ajax-loader
rocket

API

Contact

Destination

Sender

SMS Model

SMS

SMS responses

User

Retrieve an SMS template

This service allows you to retrieve an SMS template from your list.

POST   https://api.avosms.com/v1/model/sms/information


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
modelId ID of the SMS template to retrieve

Example


<?php
$curl = curl_init("https://api.avosms.com/v1/model/sms/information"); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_COOKIESESSION, true);
$postfields = array( 'id' => "{ID}", //REQUIRED 'key' => "{KEY}", //REQUIRED 'modelId' => "{MODEL ID}", //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;
if($code == "OK") { $modelName = $response->model_name; $modelContent = $response->model_content; $modelCreatioDate = $response->model_creation_date; }
?>


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.
model_name Name of the SMS model
model_content Content of the SMS template
model_creation_date Date of creation of the SMS template (format: YYYY-MM-DD HH:MM:SS)


In case of an error in the formatting / your input :
ERR_100 Unrecognized APIs.
ERR_101 No existing SMS template for the given ID


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?