Skip to navigation

Enable or disable inbound calls

Turn inbound calls on or off for one number.

With enabled: false the number rejects incoming calls before they are answered: no call record is created and nothing is billed. Messaging in both directions and outbound calls are unaffected. The setting is kept when the number is attached to an agent or the agent is edited, so a number can hold an agent assignment for messaging only.

Pass the number’s id as returned by the API, not the E.164 string. Numbers that cannot enforce the setting return 422: messaging-only lines, and most numbers that route calls to your own SIP trunk, which manage inbound calls on your platform instead.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

number_idstringRequired

Headers

X-Sub-Account-IdstringOptional

Request

This endpoint expects an object.
enabledbooleanRequired

false rejects inbound calls on this number; true answers them again.

Response

Successful Response
successboolean
inboundCallsEnabledboolean

Errors

422
Unprocessable Entity Error