NAV

Message(Last Updated : 01/04/2017)

PUT Message

Receive a detailed report of the success or failure of your message blast including tallies of the total messages in your blast, the number of messages successfully delivered, and the number of failed messages.

Sometimes, the delivery report will be updated by the carrier after the first PUSH message. We will send additional PUSH messages with updated DR Codes whenever we receive an updated delivery report from the carrier.

Body Parameters

Parameter Description
push_id The key for the specific push message.
request_id The key for the specific request.
message_id The message’s unique ID number.
status The result of the request.
email The result of the sent email. See Email Object table below.
sms/mms The result of the sent SMS/MMS. See SMS/MMS Object table below.
used_credit The amount of credits used for the message. See Used Credit Object table below.
delivery_report The result of a sent message including any reason for failure. See Delivery Report Object table below.
status_code A code notifying the member of the reason for the error. Status Code List
error_data If there is additional data for the status_code, we will give it with this parameter. See Error Data Object table below.

> Email Object

Parameter Description
total Total amount sent.
sent Total messages successfully sent.
failed Total failed messages.

> SMS/MMS Object

Parameter Description
total Total amount sent.
sent Total messages successfully sent.
failed Total failed messages.
blocked_subscription_list The list of mobile numbers blocked by carrier. See Blocked Subscription List Object table below.

>> Blocked Subscription List Object

Parameter Description
id The subscriber's unique ID number.
number Mobile phone number.
country_code Country code of the number.

> Used Credit Object

Parameter Description
domestic Used domestic credits.
international Used international credits.

> Delivery Report Object

Parameter Description
sms/mms See SMS/MMS Object table below.
email See Email Object table below.

>> SMS/MMS Object

Parameter Description
task_id The message's unique ID number.
number Mobile phone number.
country_code Country code of the number.
dr_code Delivery report code of the sent message. DR Code List

>> Email Object

Parameter Description
task_id The message's unique ID number.
address Email address.
dr_code Delivery report code of the sent message. DR Code List

Code sample for PUT Message

"Example (Success):"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "message_id" : 987987987987,
  "status" : "sent",
  "sms":
  {
    "total" : 2,
    "sent" : 1,
    "failed" : 1,
    "blocked_subscription_list" :
    [
      {
        "id" : 987987987980,
        "number" : " 4564564562",
        "country_code" : 1
      }
    ]
  },
  "email":
  {
    "total" : 3,
    "sent" : 2,
    "failed" : 1
  },
  "used_credit" :
  {
    "domestic" : 100,
    "international" : 20
  },
  "delivery_report" :
  {
    "sms" :
    [
      {
        "task_id" : 987987987980,
        "number" : "4564564562",
        "country_code" : 1,
        "dr_code" : "DR001"
      }
    ],
    "email" :
    [
      {
        "task_id" : 789789789002,
        "address" : "subscriber_email0001@email.com",
        "dr_code" : "DR110"
      }
    ]
  }
}

"Example (Success): When the delivery report is updated by the recipient's carrier after the first push message is sent."
{
  "push_id" : 7778889990001,
  "request_id" : "1234561234567asdf123",
  "message_id" : 987987987987,
  "status" : "sent",
  "sms":
  {
    "total" : 2,
    "sent" : 2,
    "failed" : 0
  },
  "delivery_report" :
  {
    "sms" :
    [
      {
        "task_id" : 987987987980,
        "number" : "4564564562",
        "country_code" : 1,
        "dr_code" : "DR000"
      }
    ]
  }
}

"Example (Failure):"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPCE3201"
}

"Example (Failure): status_code - MPME1002. You can get the invalid file URL url via error_data."
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME1002",
  "error_data" :
  {
    "resource" : "http://yourdomain.com/image.zip"
  }
}

DELETE Message

A report indicating whether your scheduled message was successfully canceled or not will be pushed to your designated URL.

Body Parameters

Parameter Description
push_id The key for the specific push message.
request_id The key for the specific request.
message_id The message’s unique ID number.
status_code A code notifying the member of the reason for the error. Status Code List

Code sample for DELETE Message

"Example (Success):"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "message_id" : 987987987980,
  "status_code" : "MPCE0000"
}

"Example (Failure):"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2019"
}