POST ​/api​/v3​/sms​/invite

Internal only API Sends an SMS invite to join DeliRadio the specified recipient/phone number.

Request

Example Request

{
  "key": "abababedededfcfcfc123",
  "auth_token": "7a3de6218cf9b64139c29b13f9784af692ada11286835c6aa30f360c9",
  "phone_number": "111-222-3333",
  "recipient": "Jim Jackson"
}

Example Parameters

  • key: Your consumer key (used for all signed API requests)

    • Required: yes
    • Type: string
    • Example: abababedededfcfcfc123
  • auth_token: The logged in user's auth token. Retrieve one by logging in.

    • Required: yes
    • Type: string
    • Example: 7a3de6218cf9b64139c29b13f9784af692ada11286835c6aa30f360c9
  • phone_number: The phone number of the recipient. Assumed to be valid. If an invalid number is specified the SMS will not be sent.

    • Required: yes
    • Type: string
    • Example: 111-222-3333
  • recipient: The name of the recipient. Used to format the message.

    • Required: yes
    • Type: string
    • Example: Jim Jackson

Response

Example Response

{
  "status": "Sent"
}

Response Parameters

  • status: The status of the request.
    • Required: yes
    • Type: string
    • Example: Sent

Response Codes

Successful Response Codes

  • 200: The SMS message was scheduled to be sent.

Failure Response Codes

  • 403: This endpoint is forbidden. Returned for 3rd party API consumers.

  • 401: Unauthorized. You must send a value auth_token for this endpoint to identify the sender.