Set Receive Callback

Configure the callback URL to notify when a call is received. Each FoneNumber can be configured to use its own callback URL for handling receive notifications.

This endpoint is used to set up a callback whenever an incoming call is received.

{
  "fonenumber": {
    "fonenumber": "5559991000",
    "sms_options": {
      ...
    },
    "voice_options": {
      ...
    },
    "fax_options": {
      ...
    },
    ...
  }
}

Response Properties

PropertyTypeDescription
fonenumberobjectFoneNumber

Callback Data

ParameterTypeDescription
account_codestringAccount billed for call
directionstringOUTBOUND or INBOUND
statusstringBEGIN or END
fromstringUnique identifier for the call.
tostringUnique identifier for the call.
typestringVOICE or FAX
dispositionstringOne of the following:
  • ANSWERED
  • NO_ANSWER
  • REJECTED
  • BUSY
  • CANCEL
  • INVALID
  • FAILED
  • FAILED:###
uidstringUnique identifier for the call.

For more information, see Callbacks / Web Hooks.

Language
Authorization
Header
Click Try It! to start a request and see the response here!