API-x JSON Data on Failure

  31 January 2017

When you make an unsuccessful call to the API-x, an error response is returned. This can be in any of the following formats.

Authentication Error

When there is an authentication error the response is in the format below:

1001||{JSON_DATA}

JSON Data Format

{
 "error": "true",
 "comment": "Reason for the error",
}

sn

Parameter

Type

Description

1

"error"

Boolean

This will be set to TRUE.

2

"comment"

String

Description of the error. Possible causes are: Invalid token, expired token and Error validating token

Error Sending SMS

When there is an error sending SMS the reply will be in the format below:

1002||{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": ""
}

The json data will be exactly as when a message is sent successfully to provide detailed insight to the reason for the failure. Possible reasons are application error, gateway error or parameter error. Our support centre will be very glad to provide the needed assistance should you encounter error sending SMS. You can please mail This email address is being protected from spambots. You need JavaScript enabled to view it. to get one of developers to attend to you.

Insufficient Balance

When there is an insufficient balance error, the response is in the format below:

1003||{JSON_DATA}

JSON Data Format

{
 "available": "30",
 "needed": "62",
}

sn

Parameter

Type

Description

1

"available"

Float

Currently available SMS balance

2

"needed"

Float

The required SMS credit to deliver the message.

No Valid Phone Number Found

When there is no valid phone number found, the recipient string the response is in the format below:

1004||{JSON_DATA}

JSON Data Format

{
 "invalid": "23470342333261,234803551586"
}

 

sn

Parameter

Type

Description

1

"invalid"

String

List of the invalid phone numbers found.

Application Error

When there is a general application error the response is in the format below:

1005||{JSON_DATA}

JSON Data Format

{
 "error": "true",
 "comment": "Reason for the error",
}

sn

Parameter

Type

Description

1

"error"

Boolean

This will be set to TRUE.

2

"comment"

String

Description of the error.

 

Unregistered Sender ID

Certain categories of messages require that the Sender IDs are pre-registered. If the Sender ID supplied is not part of the pre-registered group, the message will fail with the following error:

1008||{JSON_DATA}

JSON Data Format

{
 "error": "true",
 "comment": "Reason for the error",
}

sn

Parameter

Type

Description

1

"error"

Boolean

This will be set to TRUE.

2

"comment"

String

Description of the error.

 

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

  • Gire Benjamin Gire Benjamin
    B Be Rest assured you will Sir/Ms. Compliments of the season .

    Read more...

     
  • majek_16 majek_16
    Notify me pls

    Read more...

     
  • Mohammed Zia-ul-haq Mohammed Zia-ul-haq
    Good day Sir, Thanks for reaching us here, We are glad to notify you that your SMS account has been ...

    Read more...

     
  • Mohammed Zia-ul-haq Mohammed Zia-ul-haq
    Good day sir, Please find the meaning of the 3 options under DND Management: 1. Use Basic Route ...

    Read more...

     
  • Olusegun Olusegun
    I need to understand this DND, corporate route and all this jargon comment ...

    Read more...

Blog Calendar

« April 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
29 30