Send Sms
curl --request POST \
--url https://api.example.com/sms \
--header 'ApiKey: <apikey>' \
--header 'Content-Type: application/json' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>' \
--data '
{
"destinations": "[\"+3300000000\",\"+330000001\"]",
"message": "my message",
"senderName": "my company",
"webhookUrl": "https://my.webhook.target"
}
'import requests
url = "https://api.example.com/sms"
payload = {
"destinations": "[\"+3300000000\",\"+330000001\"]",
"message": "my message",
"senderName": "my company",
"webhookUrl": "https://my.webhook.target"
}
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ApiKey: '<apikey>',
MerchantId: '<merchantid>',
Environment: '<environment>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
destinations: '["+3300000000","+330000001"]',
message: 'my message',
senderName: 'my company',
webhookUrl: 'https://my.webhook.target'
})
};
fetch('https://api.example.com/sms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/sms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'destinations' => '["+3300000000","+330000001"]',
'message' => 'my message',
'senderName' => 'my company',
'webhookUrl' => 'https://my.webhook.target'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Content-Type: application/json",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/sms"
payload := strings.NewReader("{\n \"destinations\": \"[\\\"+3300000000\\\",\\\"+330000001\\\"]\",\n \"message\": \"my message\",\n \"senderName\": \"my company\",\n \"webhookUrl\": \"https://my.webhook.target\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/sms")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.header("Content-Type", "application/json")
.body("{\n \"destinations\": \"[\\\"+3300000000\\\",\\\"+330000001\\\"]\",\n \"message\": \"my message\",\n \"senderName\": \"my company\",\n \"webhookUrl\": \"https://my.webhook.target\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/sms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destinations\": \"[\\\"+3300000000\\\",\\\"+330000001\\\"]\",\n \"message\": \"my message\",\n \"senderName\": \"my company\",\n \"webhookUrl\": \"https://my.webhook.target\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "sms_QIVmCKgbOAcXm4BbVt15H",
"senderId": "1",
"senderName": "my_company",
"destination": "+33600000000",
"smsCount": "7",
"message": "My message",
"status": "received",
"createdAt": "2021-08-19 11:00:31.225+00",
"sentAt": "2021-08-19 11:00:31.229+00",
"receivedAt": "2021-08-19 11:00:32.225+00",
"failureCause": "{\"FailureCause\": \"not_delivered\",\n \"message\":\"Le message a été envoyé mais n'a pas pu être délivré.\"\n }"
}
]{
"status": 400,
"error": {
"statusCode": 400,
"message": [
"destination.provider must be a string"
],
"error": "Bad Request"
}
}{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted",
"merchant_inactive"
],
"message": "An error occurred on our system. Please try again later."
}Sms
Send Sms
Send Sms to different destinations.
POST
/
sms
Send Sms
curl --request POST \
--url https://api.example.com/sms \
--header 'ApiKey: <apikey>' \
--header 'Content-Type: application/json' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>' \
--data '
{
"destinations": "[\"+3300000000\",\"+330000001\"]",
"message": "my message",
"senderName": "my company",
"webhookUrl": "https://my.webhook.target"
}
'import requests
url = "https://api.example.com/sms"
payload = {
"destinations": "[\"+3300000000\",\"+330000001\"]",
"message": "my message",
"senderName": "my company",
"webhookUrl": "https://my.webhook.target"
}
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ApiKey: '<apikey>',
MerchantId: '<merchantid>',
Environment: '<environment>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
destinations: '["+3300000000","+330000001"]',
message: 'my message',
senderName: 'my company',
webhookUrl: 'https://my.webhook.target'
})
};
fetch('https://api.example.com/sms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/sms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'destinations' => '["+3300000000","+330000001"]',
'message' => 'my message',
'senderName' => 'my company',
'webhookUrl' => 'https://my.webhook.target'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Content-Type: application/json",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/sms"
payload := strings.NewReader("{\n \"destinations\": \"[\\\"+3300000000\\\",\\\"+330000001\\\"]\",\n \"message\": \"my message\",\n \"senderName\": \"my company\",\n \"webhookUrl\": \"https://my.webhook.target\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/sms")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.header("Content-Type", "application/json")
.body("{\n \"destinations\": \"[\\\"+3300000000\\\",\\\"+330000001\\\"]\",\n \"message\": \"my message\",\n \"senderName\": \"my company\",\n \"webhookUrl\": \"https://my.webhook.target\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/sms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destinations\": \"[\\\"+3300000000\\\",\\\"+330000001\\\"]\",\n \"message\": \"my message\",\n \"senderName\": \"my company\",\n \"webhookUrl\": \"https://my.webhook.target\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "sms_QIVmCKgbOAcXm4BbVt15H",
"senderId": "1",
"senderName": "my_company",
"destination": "+33600000000",
"smsCount": "7",
"message": "My message",
"status": "received",
"createdAt": "2021-08-19 11:00:31.225+00",
"sentAt": "2021-08-19 11:00:31.229+00",
"receivedAt": "2021-08-19 11:00:32.225+00",
"failureCause": "{\"FailureCause\": \"not_delivered\",\n \"message\":\"Le message a été envoyé mais n'a pas pu être délivré.\"\n }"
}
]{
"status": 400,
"error": {
"statusCode": 400,
"message": [
"destination.provider must be a string"
],
"error": "Bad Request"
}
}{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted",
"merchant_inactive"
],
"message": "An error occurred on our system. Please try again later."
}Headers
Body
application/json
Response
Datetime in UTC timezone at which the sms was created. Follows theDatetime ISO.
Example:
"2021-08-19 11:00:31.225+00"
Datetime in UTC timezone at which the sms was sent. Follows theDatetime ISO.
Example:
"2021-08-19 11:00:31.229+00"
Datetime in UTC timezone at which the sms was received. Follows theDatetime ISO.
Example:
"2021-08-19 11:00:32.225+00"
