patch/phone/numbers/{phoneIdentityId}

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/phone/numbers/{phoneIdentityId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

phoneIdentityIdstring required

The number to update

Request body

voiceIdstring nullable required

Voice id from the catalog, or null to fall back to the agent's voice. Rejected if the id is not in the catalog.

Response

OK

idstring required

Unique identifier of the phone identity

phoneNumberstring required

Phone number in E.164 format

providerIdstring nullable required

Opaque carrier-side identifier for this phone number

tenDlcStatus'PENDING' | 'REGISTERED' | 'REJECTED' | 'NOT_REQUIRED' | 'UNREGISTERED' required

10DLC campaign registration status

isPrimaryboolean required

Whether this is the agent's primary phone identity

voiceIdstring nullable required

The voice this number answers with, from the voice catalog. Null means it uses the agent's voice, and then the system default. Set it per number so one agent's support line and sales line can sound different.

createdAtstring date-time required

Timestamp when the phone identity was created

Changes

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