GuidesAPI Reference

List FoneNumbers

Get FoneNumbers API

Response for filter=all

{
  "fonenumbers": [
    {
      "fonenumber": "3215551111",
      "label": "Demo Number",
  		"group": "Demo Group",
      "record_calls": "Default",
      "message_options": {
        "receive": {
          "type": "email",
          "email": "[email protected]",
          "device": "987123543678",
          "forward": "3215553333",
          "url": "https://hookb.in/KlwpR3j5",
          "url_method": "JSON"
        },
        "receive_notify": {
          "type": "Callback",
          "email": "",
          "url": "https://hookb.in/KNRzy7P3",
          "method": "JSON"
        },
        "send_notify": {
          "type": "Callback",
          "email": "",
          "url": "https://hookb.in/vewOPNyB",
          "method": "JSON"
        },
        "messaging_enabled": "yes"
      },
      "call_options": {
        "receive": {
          "type": "Forward",
          "value": "3215553333"
        },
        "receive_notify": {
          "type": "Callback",
          "email": "",
          "url": "https://hookb.in/KNRzy7P3",
          "method": "JSON"
        },
        "send_notify": {
          "type": "Callback",
          "email": "",
          "url": "https://hookb.in/vewOPNyB",
          "method": "JSON"
        }
      },
      "fax_options": {
        "receive_notify": {
          "type": "Callback",
          "email": "",
          "url": "https://hookb.in/KNRzy7P3",
          "method": "JSON"
        },
        "send_notify": {
          "type": "Callback",
          "email": "",
          "url": "https://hookb.in/vewOPNyB",
          "method": "JSON"
        }
      },
      "is_active": "yes",
      "rate_center": "Orlando",
      "state": "FL"
    }
  ]
}
PropertyTypeDescription
fonenumberstringFoneNumber.
labelstringLabel for FoneNumber.
groupstringGroup ID for FoneNumber.
record_callsstringCall recording configuration of FoneNumber. Potenial values are:
  • Default - Account default configuration
  • Yes - Record calls for FoneNumber
  • No - Don't record calls for FoneNumber
  • InBount - Only record in-coming calls for FoneNumber
  • OutBound - Only record out-going calls for FoneNumber
message_optionsobjectSMS related properties.
message_options.receiveobjectDelivery service type used as the destination to receive messages.
message_options.receive.typestringConfigured service type.
message_options.receive.emailstringEmail address if configured for email.
message_options.receive.devicestringFracTEL device if configured for device.
message_options.receive.forwardstringTelephone number if configured for forward.
message_options.receive.urlstringHTTP URL if configured for URL.
message_options.receive.url_methodstringHTTP URL method if configured for URL.
message_options.receive_notifyobjectEmail or Callback URL to notify when a message is received.
message_options.receive_notify.typestringNotification type. Potenial values are:
  • None - Disable Notification
  • Email - Email Notification
  • Callback - Callback Notification
message_options.receive_notify.emailstringEmail address if configured for Email.
message_options.receive_notify.urlstringHTTP URL.
message_options.receive_notify.url_methodstringHTTP URL method.
message_options.send_notifyobjectEmail or Callback URL to notify when a message is sent.
message_options.send_notify.typestringNotification type. Potenial values are:
  • None - Disable Notification
  • Email - Email Notification
  • Callback - Callback Notification
message_options.send_notify.emailstringEmail address if configured for Email.
message_options.send_notify.urlstringHTTP URL
message_options.send_notify.url_methodstringHTTP URL method
message_options.messaging_enabledstringSMS/MMS service is enabled for FoneNumber. 'yes' if MMS is enabled, 'sms_only' if SMS is enabled and 'no' if both are disabled.
call_optionsobjectSMS related properties.
call_options.receiveobjectDelivery service type used as the destination to receive messages.
call_options.receive.typestringConfigured service type.
call_options.receive.valuestringService id.
call_options.receive_notifyobjectEmail or Callback URL to notify when a message is received.
call_options.receive_notify.typestringNotification type. Potenial values are:
  • None - Disable Notification
  • Email - Email Notification
  • Callback - Callback Notification
call_options.receive_notify.emailstringEmail address if configured for Email.
call_options.receive_notify.urlstringHTTP URL.
call_options.receive_notify.url_methodstringHTTP URL method.
call_options.send_notifyobjectEmail or Callback URL to notify when a message is sent.
call_options.send_notify.typestringNotification type. Potenial values are:
  • None - Disable Notification
  • Email - Email Notification
  • Callback - Callback Notification
call_options.send_notify.emailstringEmail address if configured for Email.
call_options.send_notify.urlstringHTTP URL
call_options.send_notify.url_methodstringHTTP URL method
fax_optionsobjectSMS related properties.
fax_options.receive_notifyobjectEmail or Callback URL to notify when a message is received.
fax_options.receive_notify.typestringNotification type. Potenial values are:
  • None - Disable Notification
  • Email - Email Notification
  • Callback - Callback Notification
fax_options.receive_notify.emailstringEmail address if configured for Email.
fax_options.receive_notify.urlstringHTTP URL.
fax_options.receive_notify.url_methodstringHTTP URL method.
fax_options.send_notifyobjectEmail or Callback URL to notify when a message is sent.
fax_options.send_notify.typestringNotification type. Potenial values are:
  • None - Disable Notification
  • Email - Email Notification
  • Callback - Callback Notification
fax_options.send_notify.emailstringEmail address if configured for Email.
fax_options.send_notify.urlstringHTTP URL
fax_options.send_notify.url_methodstringHTTP URL method
is_activestringStatus of FoneNumber. Potenial values are:
  • yes - active
  • no - pending cancelation
rate_centerstringRate center for FoneNumber.
statestringUS State of registration for FoneNumber.

Response for filter=FoneNumber

{
  "fonenumbers": [
    "8005556562",
    "8555552835",
    "3215556727",
    "3215552240",
    "3215551005"
  ]
}
PropertyTypeDescription
fonenumberstringFoneNumber.