17 Dec Get Price function

 

To retrieve the current outbound price for a particular country based on its country code.

To send a message the request must be submitted one of the following URLs:

HTTP (non-SSL)

HTTPS (SSL) *recommended*

 

5.1 Authentication Information

For the Send SMS Message method, the POST HTTP method must be used.

2.2 Authentication Information

All requests require API Key and API Secret authentication credentials. Account Administrators can login to view their account API Key and API Secret in the “My Profile > Settings” section.

To authenticate a request, please use one of the following options:

In the header of the request for “apiKey

Parameter Name

apiKey

Description

The account’s API username (key). Its a 32 character random string.

Example:

 

Variable Type

String

Mandatory?

YES

 

In the header of the request for “apiSecret

Parameter Name

apiSecret

Description

The account’s API password (secret). Its a numeric random string with a random length between 10 and 15 characters.
Example:

 

Variable Type

String

Mandatory?

YES

 

5.2 HTTP Methods

All requests should be submitted through the HTTP GET Method.

Request Parameters for “countryCode“:

Parameter Name

countryCode

Description

A 1, 2, or 3 digit international country code.For Example: For USA the country code = 1

Variable Type

Integer

Mandatory?

YES

 

5.3.1 Examples using GET Method

PHP example

 

Java example (with Apache HTTPClient)

 

5.4 Response Parameters

 

Key

Description

Variable Type

responseType

An ENUM that represents the return code for the response. Please reference Response Codes table in Annex A. String

networkPriceList

An JSON object for:

  • countryName (string)
  • networkName (string)
  • price (decimal)

Example:

Object

countryCode

A 1, 2, or 3 digit international country code.
Example:
Integer

requestResponseId

An integer representing the return code of the response / error. Please reference Response Codes table in Annex A.

requestResponseDescription

An integer representing the return code of the response / error. Please reference Response Codes table in Annex A. String