post/phone/provision

Request

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

Request body

countryCodestring

ISO 3166-1 alpha-2 country code for number selection

numberType'local' | 'mobile' | 'national' | 'toll_free' | 'shared_cost'

Phone number type to provision (treated as local when omitted)

areaCodestring

Preferred area code for the phone number

capabilitiesstring[]

Required capabilities for the phone number

Response

OK

idstring required

Unique identifier for the provisioned phone record

phoneNumberstring required

E.164 formatted phone number that was provisioned

providerIdstring nullable required

Opaque carrier-side identifier for the number

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

10DLC campaign registration status for A2P SMS compliance

isPrimaryboolean required

Whether this is the primary phone number for the agent

createdAtstring date-time required

ISO 8601 timestamp when the number was provisioned

Changes

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