ajax-loader
rocket

API

Contact

Destination

Sender

SMS Model

SMS

SMS responses

User

Create a sender

This service allows you to create an Avosms sender.

POST   https://api.avosms.com/v1/sender/create


Parameters

All the parameters below are to be sent in POST.

List of mandatory parameters
id Your AvoSMS account ID (email address)
key API key available from your "API Access" customer account
sender Sender name (must be between 3 and 11 characters)

Example


<?php
$curl = curl_init("https://api.avosms.com/v1/sender/create"); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_COOKIESESSION, true);
$postfields = array( 'id' => "{ID}", //REQUIRED 'key' => "{KEY}", //REQUIRED "sender" => "{SENDER}", //REQUIRED );
$postfields_json = json_encode($postfields); $trame = http_build_query($postfields, '', '&'); curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_POSTFIELDS, $trame); $raw_response = curl_exec($curl); curl_close($curl);
$response = json_decode($raw_response);
$status_response = $response->status; $code = $response->code;
?>


Codes / Answers

When you make a request to our services, a response is returned to you in JSON format. You will find in the "code" field the return code following your request. In case of success, the return code contains " OK ".


If successful:
code (OK) Your request has been processed correctly. The sender name has been successfully created.


In case of an error in the formatting / your input :
ERR_100 Unrecognized APIs.
ERR_101 Error on sender name "sender" (must be between 3 and 11 characters).
ERR_102 The sender name "sender" is not allowed.
ERR_103 The sender name "sender" already exists.


In the event of an error in processing by our services :
ERR_9XX Processing error, contact our services.
An internal processing error is reported to you by an error code "ERR_9XX", i.e. XX = non-fixed digits, depending on the type of error.


Have a question? Do you need help?