API-x JSON Data on Success

  31 January 2017

When call to API-x is successful, the response returned is 1000 followed by a pair of vertical lines and a json data.

JSON Data format

{
 "successful": "",
 "basic_successful": "",
 "corp_successful": "",
 "failed": "",
 "insufficient_unit": "",
 "invalid": "",
 "all_numbers": "",
 "units_used": ,
 "basic_units": ,
 "corp_units": ,
 "units_before": "",
 "units_after": "",
 "sms_pages": ,
 "filtered_active": "",
 "filtered_dead": "",
 "filtered_nodata": "",
 "filtered_dnd": "",
 "realtime_dnd": "",
 "message_id": ""
}

 

Explanation of the JSON Data

Parameter

Type

Description

successful

String

This lists the phone numbers that the message has been sent successfully separated by commas (,). These constitute the billable phone numbers.

basic_successful

String

This lists the phone numbers that were successfully sent via the Basic Route.

corp_successful

String

This lists the phone numbers that were successfully sent via the Corporate Route.

failed

String

This lists the phone numbers that the message could not be delivered. Phone numbers in this list are NOT billed. Possible causes are:

a. Unsupported gateway

b. Message rejected by the operator

c. Phone numbers could not be parsed

insufficient_unit

String

Phone numbers that failed because there was no sufficient SMS credit to send messages to them.

invalid

String

Invalid phone numbers that were removed from the recipients’ parameter string. These are not billed.

all_numbers

String

All the valid phone numbers supplied from the recipients string.

units_used

Float

The sum of SMS units used

basic_units

Float

The sum of SMS units used to send messages via the Basic Route

corp_units

Float

The sum of SMS units used to send messages via the Corporate Route

units_before

Float

The account balance before the message was sent

units_after

Float

The account balance after the message has been sent

sms_pages

Integer

The number of pages of the SMS

filtered_active

String

This will be populated when set routing=2. This shows phone numbers that were filtered as active during the phone number validity test.

filtered_dead

String

The will be populated when set routing=2. This shows phone numbers that are currently dead/inactive based on the available data used for the validity test.

filtered_nodata

String

The will be populated when set routing=2. This shows phone numbers that we do not have any data on as at the time of query.

filtered_dnd

String

The will be populated when set routing=2. This shows phone numbers that are on DND based on available data.

realtime_dnd

String

This shows phone numbers that the operator signals as being on DND. This provides more accurate DND status for the phone number.

message_id

String

The unique server generated identifier for the message.

 

 

REGISTER FREE

  • 10 Free SMS on Sign-Up
  • 5% Bonus on First Purchase
  • Delivery Report Available
  • Most Affordable Pricing
  • Easy Payment Channels

Popular Posts

Headlines

Latest Comment

  • support support
    I made payment via internet transfer but the text I sent is not delivering. Please kindly credit ...

    Read more...

     
  • Gire Benjamin Gire Benjamin
    Good Evening Sir , I am very sorry for that experience Sir.. The Notification on the Site tells Us ...

    Read more...

     
  • EZECHUKWU HENRY UGONNA EZECHUKWU HENRY UGONNA
    Most of my dnd numbers did not got my sms even when using option2. Some messages was sent but was not ...

    Read more...

     
  • Olorunlami Jephthah Olorunlami Jephthah
    Good day The Fig, thank you so much for reaching us here. As discussed with you over the phone, this ...

    Read more...

     
  • The fig montenssori school The fig montenssori school
    Please, why the sender name change on delivery to another name?

    Read more...

Blog Calendar

« February 2019 »
Mon Tue Wed Thu Fri Sat Sun
        1 2 3
4 5 6 7 8 9 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28