Skip to main content

AllocateAvailableDID finds and allocates an available DID.

POST 
/api/v1/voice/admin/did-pool/allocate-available

Searches for an available DID matching the criteria and allocates it. Useful for automated provisioning.

Parameters​

  • organization_id: Required, target organization
  • country_code: Required, desired country
  • number_type: Optional, preferred number type
  • subscription_id: Optional, billing subscription link
  • subscription_item_id: Optional, billing item link

Response​

Returns the allocated pool item.

Errors​

  • NOT_FOUND: No available DIDs match criteria
  • PERMISSION_DENIED: Caller lacks voice:admin permission

Request​

Responses​

A successful response.