Skip to content

Get Status

The status of the message can be requested by specifying the request_id that was returned from Send Message endpoint.

Endpoint

GET
/report/v1/message-log/{request_id}


POSTMAN

Authentication

AUTHORIZATIONS: Bearer Token

Request parameters

Parameter Value / Pattern Example(s)
*request_id request_id that was returned from Send Message endpoint ceba9fac-838c-44c7-b67d-03a4a6352058

Response:

200 - Success 
{
    "request_id": "9d056a09-0fc4-4f68-9058-3846d58aa244",
    "total_recipients": 2,
    "channel": "sms",
    "messages": [
        {
            "msg_id": "7053a678-75fe-11ed-9e31-0242ac14001c",
            "country": "AE",
            "recipient": "+9715097526xx",
            "status": "sent",
            "number_of_sms": 4,
            "sms_cost": 0.0004,
            "schedule_time": null
        },
        {
            "msg_id": "7052cd16-75fe-11ed-9e31-0242ac14001c",
            "country": "AE",
            "recipient": "+9715097526xx",
            "status": "sent",
            "number_of_sms": 4,
            "sms_cost": 0.0004,
            "schedule_time": null
        }
    ]
}
404 - Not Found 
{
    "detail": {
        "code": "MESSAGE_LOG_NOT_EXISTS",
        "message": "Given message request id not exists in the system. Please Try Again!"
    }
}

Response Parameters

Parameter Value / Pattern Example(s)
total_recipients Total number of recipients in the request 1
channel Messaging channels such as SMS, MMS, and Audio sms
msg_id The message id for each message in the request 5c8d9ed8-590b-11ed-93d2-0242ac140018
country Two-digit ISO code of the destination country AE
recipient Destination numbers +971509752655
status This is the status of the message, and we have the following statuses: [delivered - Delivered to destination and confirmed], [sent - Was sent to telecom and is awaiting acknowledgement], [scheduled - Message scheduled], [un_delivered - Failed delivery], [not_reachable - Recipient is not reachable], [spam_content - SMS Content is identified Spam], [insufficient_credit - User does not have enough credit] delivered
number_of_sms The number of total message parts. Sending a long message over 158 characters will be split into multiple messages and forwarded to telecom. It is a maximum of 72 characters per message if you send Unicode messages 1
sms_cost The cost of the message 0.0001
schedule_time If the message is scheduled, this will return the time null

Programming Examples

1
2
curl --location -g --request GET 'https://api.d7networks.com/report/v1/message-log/{{request_id}}' \
--header 'Authorization: Bearer {{api_access_token}}'

npm i direct7

1
2
3
4
5
6
7
const Client = require('direct7')

const client = new Client(apiToken="Your API token")
# request_id is the id returned in the response of send_message
const response = await client.sms.getStatus({request_id:"0015e146-4edb-4302-91fe-cdcf868a6cf2"});

console.log(response);

pip install direct7

1
2
3
4
5
6
from direct7 import Client

client = Client(api_token="Your API token")

# request_id is the id returned in the response of send_message
client.sms.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")


composer require direct7/direct7-php

require_once 'vendor/autoload.php';

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
require_once __DIR__ . '/vendor/autoload.php';

use direct7\Direct7\Client;

$client = new Client(api_token="Your API token")

# request_id is the id returned in the response of send_message
$response = $direct7->sms->getStatus(request_id:'00145469-b503-440a-bb0c-59af8a598a7f');

var_dump($response);

go get -u github.com/d7networks/direct7-go-sdk

1
2
3
4
5
6
7
8
import (
"github.com/d7networks/direct7-go-sdk/direct7"
)   
apiToken := "Your Api Token"
client := direct7.NewClient(apiToken)
sms := direct7.NewSMS(client)
requestID := "001ff613-de30-4f82-81f6-1fe944b8f61b"
statusResponse, err := sms.GetStatus(requestID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.d7networks.com/report/v1/message-log/{{request_id}}")
.method("GET", body)
.addHeader("Authorization", "Bearer {{api_access_token}}")
.build();
Response response = client.newCall(request).execute();

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
var headers = {
'Authorization': 'Bearer {{api_access_token}}'
};
var request = http.Request('GET', Uri.parse('https://api.d7networks.com/report/v1/message-log/{{request_id}}'));

request.headers.addAll(headers);

http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
print(await response.stream.bytesToString());
}
else {
print(response.reasonPhrase);
}

1
2
3
4
5
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Authorization", "Bearer {{api_access_token}}")

$response = Invoke-RestMethod 'https://api.d7networks.com/report/v1/message-log/{{request_id}}' -Method 'GET' -Headers $headers
$response | ConvertTo-Json

gem install direct7

1
2
3
4
5
6
require 'direct7'

client = Direct7::Client.new('Your API token')

# request_id is the id returned in the response of send_message
client.sms.get_status(request_id= '001a1a4e-0221-4cb7-a524-a2a5b337cbe8')