Delete number

Delete number

DELETE

https://api.agora.io/api/conversational-ai-agent/v2/phone-numbers/{phone_number}

Use this endpoint to remove imported phone numbers from the system.

info

• This operation only removes the number configuration from the Agora system; the number stored with the phone service provider is not deleted.
• After calling this endpoint, the number stops receiving calls routed through this system. To delete the number from the service provider, remove it in the service provider's console.

phone_number stringrequired

Telephone number in E.164 format. For example, +11234567890.

• If the returned status code is 204, the request was successful. The response body is empty.

• If the returned status code is not 204, the request failed. The response body includes the error code and description. Refer to status codes to understand the possible reasons for failure.

  Error Response

  • error_type string

    The type of error that occurred.

  • description string

    A detailed description of the error.

Authorization

This endpoint requires Basic Auth.

Request example

• curl
• Python
• Node.js

_3

curl --request DELETE \

_3

--url https://api.agora.io/api/conversational-ai-agent/v2/phone-numbers/:phone_number \

_3

--header 'Authorization: Basic <credentials>'

Response example

• 204
• Non-200

Empty response body