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": "support@domain.com",
          "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"
    }
  ]
}

Property	Type	Description
fonenumber	string	FoneNumber.
label	string	Label for FoneNumber.
group	string	Group ID for FoneNumber.
record_calls	string	Call 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_options	object	SMS related properties.
message_options.receive	object	Delivery service type used as the destination to receive messages.
message_options.receive.type	string	Configured service type.
message_options.receive.email	string	Email address if configured for email.
message_options.receive.device	string	FracTEL device if configured for device.
message_options.receive.forward	string	Telephone number if configured for forward.
message_options.receive.url	string	HTTP URL if configured for URL.
message_options.receive.url_method	string	HTTP URL method if configured for URL.
message_options.receive_notify	object	Email or Callback URL to notify when a message is received.
message_options.receive_notify.type	string	Notification type. Potenial values are: `None` - Disable Notification `Email` - Email Notification `Callback` - Callback Notification
message_options.receive_notify.email	string	Email address if configured for Email.
message_options.receive_notify.url	string	HTTP URL.
message_options.receive_notify.url_method	string	HTTP URL method.
message_options.send_notify	object	Email or Callback URL to notify when a message is sent.
message_options.send_notify.type	string	Notification type. Potenial values are: `None` - Disable Notification `Email` - Email Notification `Callback` - Callback Notification
message_options.send_notify.email	string	Email address if configured for Email.
message_options.send_notify.url	string	HTTP URL
message_options.send_notify.url_method	string	HTTP URL method
message_options.messaging_enabled	string	SMS/MMS service is enabled for FoneNumber. 'yes' if MMS is enabled, 'sms_only' if SMS is enabled and 'no' if both are disabled.
call_options	object	SMS related properties.
call_options.receive	object	Delivery service type used as the destination to receive messages.
call_options.receive.type	string	Configured service type.
call_options.receive.value	string	Service id.
call_options.receive_notify	object	Email or Callback URL to notify when a message is received.
call_options.receive_notify.type	string	Notification type. Potenial values are: `None` - Disable Notification `Email` - Email Notification `Callback` - Callback Notification
call_options.receive_notify.email	string	Email address if configured for Email.
call_options.receive_notify.url	string	HTTP URL.
call_options.receive_notify.url_method	string	HTTP URL method.
call_options.send_notify	object	Email or Callback URL to notify when a message is sent.
call_options.send_notify.type	string	Notification type. Potenial values are: `None` - Disable Notification `Email` - Email Notification `Callback` - Callback Notification
call_options.send_notify.email	string	Email address if configured for Email.
call_options.send_notify.url	string	HTTP URL
call_options.send_notify.url_method	string	HTTP URL method
fax_options	object	SMS related properties.
fax_options.receive_notify	object	Email or Callback URL to notify when a message is received.
fax_options.receive_notify.type	string	Notification type. Potenial values are: `None` - Disable Notification `Email` - Email Notification `Callback` - Callback Notification
fax_options.receive_notify.email	string	Email address if configured for Email.
fax_options.receive_notify.url	string	HTTP URL.
fax_options.receive_notify.url_method	string	HTTP URL method.
fax_options.send_notify	object	Email or Callback URL to notify when a message is sent.
fax_options.send_notify.type	string	Notification type. Potenial values are: `None` - Disable Notification `Email` - Email Notification `Callback` - Callback Notification
fax_options.send_notify.email	string	Email address if configured for Email.
fax_options.send_notify.url	string	HTTP URL
fax_options.send_notify.url_method	string	HTTP URL method
is_active	string	Status of FoneNumber. Potenial values are: `yes` - active `no` - pending cancelation
rate_center	string	Rate center for FoneNumber.
state	string	US State of registration for FoneNumber.

Response for `filter=FoneNumber`

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

Property	Type	Description
fonenumber	string	FoneNumber.