numbers

Import a phone number

Import a number from a connected carrier trunk. Wait for the number to become ready before using it as caller ID.

Use an admin key and a connected trunk. For Twilio, e164 must be a number on that trunk.

Wait for state: "ready" before using the number as from in a run or in agent.telephony. If provisioning is pending, repeat the import with the same body and idempotency key.

An inbound_agent_id assignment requires an inbound-enabled trunk and a published phone agent.

post/api/v1/telephony/numbers

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/telephony/numbers
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Request body

e164string required
trunk_idstring required
nicknamestring
inbound_agent_idstring nullable
outbound_agent_idstring nullable

Response

Import a phone number from a connected trunk

number_idstring uuid required
e164string required
trunk_idstring required
nicknamestring nullable required
inbound_agent_idstring nullable required
outbound_agent_idstring nullable required
inbound_agent_versioninteger nullable required

Stored inbound publication pin, including legacy version 0; null when unassigned. Publishing a newer head does not change it.

outbound_agent_versioninteger nullable required

Stored outbound publication version; null when unassigned.

state'pending' | 'ready' required
created_atstring date-time required

Changes

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