SMS Message API Methods

Table of Contents:

1 Methods Summary
- 1.1 POST /api/smses
  - 1.1.1 Description
  - 1.1.2 Request
  - 1.1.3 Example
  - 1.1.4 Response
  - 1.1.5 Response Example

Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used.

Methods Summary

POST /api/smses

Description

This method creates a new SMS message.

In order to create SMS campaign, first create the message, then create a campaign via POST api/mailings.

Request

list_id

Optional number - The list id to which the sms should be saved under

name

Required string - The name for new sms

description

Required string - The description for new sms

content_text

Required string - The plain text content

prefix

Optional string - phone number prefix

Example

POST URL: https://api.ongage.net/<list_id>/api/smses

{
 "name": "SMS Message test",
 "description": "sms description test",
 "content_text": "testing",
 "prefix": "44"
}

Response

The response includes a newly created SMS array of fields.

Response Example

{
 "metadata":
 {
  "error": false
 },
 "payload":
 {
  "id": 2027,
  "type": "sms",
  "account_id": 26099,
  "list_id": "23939",
  "name": "SMS Message test",
  "description": "sms description test",
  "content_html": null,
  "content_text": "testing",
  "created_by": "868",
  "created": 1416918541,
  "modified_by": "868",
  "modified": 1416918541,
  "deleted": null
 }
}