Call plans

Get the call plan of a number

The call plan of one number, with its version. The version is also in the ETag header; send it back as If-Match with PUT.

get/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:read)

Path parameters

idstring uuid required

The id of the number.

Response

The call plan that calls to this number follow: its own plan (source number) or, without one, the plan of the project (source project, version 0).

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.

source'number' | 'project' | 'none' required

Where plan comes from. number: the number has its own plan. project: the number has no own plan and follows the plan of the project (set_assistant sets that one up); this is what callers get. none: no plan at all.

Changes

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