SMS REST API

POST https://api.nextpod.io/v3/sms HTTP/1.1
https://api.nextpod.io/v2/sms?account_id=xxx&api_key=xxx

POST https://api.nextpod.io/v3/sms HTTP/1.1
Authorization: Basic OjZjZmJmOS05M2MwYWM2MGFjNmM1ZmMzOTAwZTU2ZDk2NmRjZDhkMmIx

POST Request examples

Here is two examples. The first shows you how to send SMS using JSON as body with Basic authentication. The second example shows how to send SMS using form-data and using your account_id and api_key as authentication.

Example using Body JSON

POST https://api.nextpod.io/v2/sms HTTP/1.1
Authorization: Basic OjZjZmJmOS05M2MwYWM2MGFjNmM1ZmMzOTAwZTU2ZDk2NmRjZDhkMmIx
Content-Type: application/json; charset=utf-8

{  
  "from": "Nextpod",
  "to": "4791726200,4758484412",
  "msg": "Hello!"
}

Example using form-data

POST https://api.nextpod.io/v2/sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=utf-8

?account_id=2532
&api_key=744ebx-btaPfo5dd0c1e15b3ed421f6e8d2c2b7b4
&from=Nextpod
&to=4791726200,4758484412
&msg=Hello!

Response examples

Example with a successful request with a single recipients

POST https://api.nextpod.io/v2/sms?account_id=xx&api_key=xx&to=4791726200&from=Nextpod&msg=Hello!

{ 
  "id": "B21BE07F-1EA0-40D3-9190-BABEFA2359FE",
  "from": "Nextpod",
  "to": "4791726200",
  "msg_length": "6",
  "msg_parts": "1",
  "reference": ""
} 

Example with a successful request with multiple recipients

POST https://api.nextpod.io/v2/sms?account_id=xx&api_key=xx&to=4791726200,4758484412&from=Nextpod&msg=Hello!

{ 
  "recipients": 2,
  "sms": [
    {
      "id": "B21BE07F-1EA0-40D3-9190-BABEFA2359FE",
      "from": "Nextpod",
      "to": "4791726200",
      "msg_length": "6",
      "msg_parts": "1",
      "reference": ""
    },
    {
      "id": "36E34627-5A4A-43F5-9483-2FDCA2AFE9CC",
      "from": "Nextpod",
      "to": "4758484412"
      "msg_length": "6",
      "msg_parts": "1",
      "reference": ""
    }
  ]
} 

Example with a failed request

Note that if one or more parameters are missing the http status code 400 will be returned. Check the http-status text for more information. You can read more about API response codes here

400 From parameter is missing or has an invalid value

API response codes

These error codes are returned by the API when posting a request to our servers.

Note that the same parameters can be sent as FORM-data if the keyword or short code are configured to use FORM and not JSON.

{
    "id": "1053289234",
    "from": "4791726200",
    "to": "2345",
    "msg": "Hello wonderful world!",
    "keyword": "HELLO",
    "sub_keyword": "WONDERFUL",
    "keyword_rules": "false",
    "mcc": "242",
    "mnc": "1",
    "received_time": "2019-08-28T15:00:00"
  }

If the parameter dlr_url is used while sending an SMS it will trigger delivery of delivery reports to the given URL. The data can be delivered as JSON or FORM. You can define the format by using the dlr_method parameter such as dlr_method = "FORM" or dlr_method = "JSON"

This example shows a delivery report with a successfully delivered SMS. The data is posted to the url specified in the dlr-url parameter while sending the sms.

POST https://your.domain.com/delivery_reports_url HTTP/1.1
Content-Type: application/json; charset=utf-8

{
  "id": "89ADEE05-5960-43D4-83B7-61EABA45F5F9",
  "reference": "5adFadX55sQfdsADFFS42",
  "to": "4791726200",
  "created_time": "2019-08-28T14:59:58Z",
  "sent_time": "2019-08-28T15:00:00Z",
  "status_updated": "2019-08-28T15:00:08Z",
  "status_code": "200",
  "status_text": "DELIVERED",
  "operator_status_code": "1001",
  "mcc": "242",
  "mnc": "1",
  "msg_parts": "1"
}

Example with FORM posted data
Data can be returned as FORM-data (application/x-www-form-urlencoded). The parameters has been rearranged to be more readable.

POST https://your.domain.com/delivery_reports_url HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=utf-8

https://your.domain.com/delivery_reports_url?id=89ADEE05-5960-43D4-83B7-61EABA45F5F9
&reference=5adFadX55sQfdsADFFS42
&to=4791726200
&created_time=2019-08-28T14:59:58Z
&sent_time=2019-08-28T15:00:00Z
&status_updated=2019-08-28T15:00:11Z
&status_code=200
&status_text=DELIVERED
&operator_status_code=1001
&mcc=242
&mnc=1
&msg_parts=1