Set Receive Callback

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

post/messages/receive_notify

Request

Base URL: https://api.fonestorm.com/v2
URL: https://api.fonestorm.com/v2/messages/receive_notify
Auth: API key in header token

Request body

fonenumberstring required

Your FracTEL FoneNumber

type'None' | 'Callback' | 'Email' required

Notification type.

emailstring

Email address. REQUIRED if type is Email.

method'GET' | 'POST' | 'JSON'

Callback URL method. REQUIRED if type is Callback.

urlstring

Callback URL. REQUIRED if type is Callback. See Notes for additional information.

url_usernamestring

Username for HTTP Basic authentication scheme

url_passwordstring

Password for HTTP Basic authentication scheme

Response

Success

Example response

{
  "fonenumber": {
    "label": "Main Office IVR",
    "group": "Main Office",
    "type": "Local",
    "record_calls": "yes",
    "state": "FL",
    "rate_center": "ORLANDO",
    "is_active": "yes",
    "message_options": {
      "receive": {
        "type": "Device"
      },
      "receive_notify": {
        "type": "URL",
        "url": "https://example.com/receive_notify",
        "method": "JSON"
      },
      "send_notify": {
        "type": "Email",
        "email": "support@fractel.net"
      },
      "messaging_enabled": "yes",
      "messaging_campaign": "CXX11XX11"
    },
    "call_options": {
      "receive": {
        "type": "Device"
      },
      "receive_notify": {
        "type": "URL",
        "url": "https://example.com/send_notify",
        "method": "JSON"
      },
      "send_notify": {
        "type": "Email",
        "email": "support@fractel.net"
      }
    },
    "fax_options": {
      "receive_notify": {
        "type": "URL",
        "url": "https://example.com/send_notify",
        "method": "JSON"
      },
      "send_notify": {
        "type": "Email",
        "email": "support@fractel.net"
      }
    },
    "e911location_options": {
      "location_id": "LO12341234",
      "e911location_id": "EN12341234",
      "e911location_default": "no",
      "e911location_active": "yes"
    },
    "activation_date": "2022-03-30",
    "is_offnet": "no"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.