Call plans

Set the call plan of a number

Replaces the call plan of one number. A plan with an ai_agent node needs the assistant (PUT /assistant; voice AI is always included) and updates the assistant with this plan. Send If-Match with the ETag from GET to avoid overwriting a newer plan.

put/numbers/{id}/call-plan

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/numbers/{id}/call-plan
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: numbers:write)

Path parameters

idstring uuid required

The id of the number.

Headers

If-Matchstring

The version from the ETag of GET, like "3". An outdated version returns 412 version_conflict.

Request body

entrystring required

The id of the first node.

nodesobject required

The nodes by id. The key must be the same as the node's id.

Response

The call plan as saved, with its new version.

number_idstring uuid required
versioninteger required

The version of the number's own plan; 0 when the number has no own plan yet. Also in the ETag header.

assistant_sync'synced' | 'failed' | 'not_needed' | 'skipped_test_mode' required

Whether the assistant was updated with this plan. not_needed for a plan without ai_agent; skipped_test_mode with a test key.

Changes

No recorded changes to this operation across all 1 revision of this API.