Call Us: (+250) 788 620 612

(HTTP API)
Application to Person

Home → Http Api

Overview

ItecSMS's HTTP API empowers you to seamlessly send and receive text messages to and from users through straightforward REST APIs.

  • Send and receive Programmatically high volumes of SMS globally.
  • Using local numbers you receive SMS .
  • Scale your applications with familiar web technologies.
  • Pay only for what you use.

This section contains the following sub sections. You can click on the link below to quickly jump to that section:

Concepts.

Prior to utilizing the ItecpaySMS SMS API, it is important to acquaint yourself with the following key aspects:

  • Phone Number Format:The SMS API mandates phone numbers to be in the E.164 format for proper functionality.
  • Authentication:To access the SMS API, authentication is performed using your account's API key and secret.
  • API Architecture: The SMS API follows the REST (REpresentational State Transfer) framework, ensuring a standardized and efficient approach to communication and data transfer.

Usage

To get started, create an ItecPay account if you haven't already and take note of your username and password. You will use these credentials to log in to your dashboard and establish a connection via the HTTP API.

Make sure to replace the placeholder values in the sample code with the following:

  • username: Your ItecPay username.
  • password: Your ItecPay password.

To send messages, utilize the HTTP "POST" method from your gateway or server to interact with the ItecPay system. Compose your code accordingly to initiate the message sending process.

Send SMS

To send an SMS through the gateway, you need to encode a JSON string containing the required parameters. Make sure to include the following parameters in the URL:

  • username (string): Your assigned account username provided by ItecPay.
  • password (string): Your account password associated with the provided username.
  • recipients (string): Phone numbers of the recipient(s) separated by commas if there are multiple recipients.
  • sender (string): The sender name or number. It can be alphanumeric.
  • message (string): The content of the message, such as "test sms" or the actual text you want to send.

After sending a message request, the response will provide a status code indicating whether the request was successful or not. Additionally, the response will include a description explaining the reason if the message failed to be sent.

The status code will fall into one of two possibilities:

  • 200 OK: No errors were encountered, and the request was processed successfully.
  • 400 Bad Request: An error was encountered during the request, indicating a failure in sending the message.

Send SMS Status Request

To track the status of a sent SMS message, you can make a JSON-encoded status request to the gateway. This request allows you to determine whether the message has been delivered, encountered an error, or is currently queued.

Here are the required parameters that need to be passed with the URL:

  • username: Your assigned username for your Intouch account.
  • password:The password provided by Intouch for your account associated with your username.
  • messageid:The message ID returned in the send SMS response.

The statuses returned in the SEND SMS status response have the following meanings:

P: The message is still being processed.
D: The message has been delivered successfully.
Q: The message is still in the queue.
E: The message has encountered an error.
S: The message has been sent to the carrier for delivery.
U: The carrier has marked the message as unsent.

This allows the client to track and monitor the progress of their SMS messages, enabling them to ensure successful delivery and take appropriate action if any errors or issues arise.

ITEC Ltd