{!! __('locale.description.sms_api', ['brandname' => config('app.name')]) !!}

                                
                                    {{ route('api.sms.send') }}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.description') }}
Authorization	{{ __('locale.labels.yes') }}	When calling our API, send your api token with the authentication type set as `Bearer` (Example: `Authorization: Bearer {api_token}`)
Accept	{{ __('locale.labels.yes') }}	Set to `application/json`

Send outbound SMS

{{ config('app.name') }}'s Programmable SMS API enables you to programmatically send SMS messages from your web application. First, you need to create a new message object. {{ config('app.name') }} returns the created message object with each request.

Send your first SMS message with this example request.

                                
                                    {{ route('api.sms.send') }}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
recipient	{{ __('locale.labels.yes') }}	string	Number to send message. `Use comma (,)` to send multiple numbers. Ex. `31612345678,8801721970168`
sender_id	{{ __('locale.labels.yes') }}	string	The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters.
type	{{ __('locale.labels.yes') }}	string	The type of the message. For text message you have to insert `plain` as sms type.
message	{{ __('locale.labels.yes') }}	string	The body of the SMS message.
schedule_time	{{ __('locale.labels.no') }}	datetime	The scheduled date and time of the message in RFC3339 format `(Y-m-d H:i)`
dlt_template_id	{{ __('locale.labels.no') }}	string	The ID of your registered DLT (Distributed Ledger Technology) content template.

Example request for Single Number

                                
curl -X POST {{ route('api.sms.send') }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'

Example request for Multiple Numbers

                                
curl -X POST {{ route('api.sms.send') }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678,880172145789",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "sms reports with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

Send Campaign Using Contact list

{{ config('app.name') }}'s Programmable SMS API enables you to programmatically send Campaigns from your web application. First, you need to create a new message object. {{ config('app.name') }} returns the created message object with each request.

Send your first Campaign Using Contact List with this example request.

                                
                                    {{ route('api.sms.campaign') }}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
contact_list_id	{{ __('locale.labels.yes') }}	string	Contact list to send message. `Use comma (,)` to send multiple contact lists. Ex. `6415907d0d7a6,6415907d0d37a`
sender_id	{{ __('locale.labels.yes') }}	string	The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters.
type	{{ __('locale.labels.yes') }}	string	The type of the message. For text message you have to insert `plain` as sms type.
message	{{ __('locale.labels.yes') }}	string	The body of the SMS message.
schedule_time	{{ __('locale.labels.no') }}	datetime	The scheduled date and time of the message in RFC3339 format `(Y-m-d H:i)`
dlt_template_id	{{ __('locale.labels.no') }}	string	The ID of your registered DLT (Distributed Ledger Technology) content template.

Example request for Single Contact List

                                
curl -X POST {{ route('api.sms.campaign') }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'

Example request for Multiple Contact Lists

                                
curl -X POST {{ route('api.sms.campaign') }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a,6415907d0d7a6",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "campaign reports with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

View an SMS

You can use {{ config('app.name') }}'s SMS API to retrieve information of an existing inbound or outbound SMS message.

You only need to supply the unique message id that was returned upon creation or receiving.

                                
                                    {{config('app.url')}}/api/v3/sms/{uid}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
uid	{{ __('locale.labels.yes') }}	string	A unique random uid which is created on the {{ config('app.name') }} platform and is returned upon creation of the object.

Example request

                                
curl -X GET {{ route('api.sms.view', ['uid' => '606812e63f78b']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "sms data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

View all messages

                                
                                    {{config('app.url')}}/api/v3/sms/

Example request

                                
curl -X GET {{ route('api.sms.index') }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "sms reports with pagination",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

View Campaign

You can use {{ config('app.name') }}'s Campaign API to retrieve information of an existing Campaigns.

You only need to supply the unique campaign id that was returned upon creation or receiving.

                                
                                    {{config('app.url')}}/api/v3/campaign/{uid}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
uid	{{ __('locale.labels.yes') }}	string	A unique random uid which is created on the {{ config('app.name') }} platform and is returned upon creation of the object.

Example request

                                
curl -X GET {{ route('api.campaign.view', ['uid' => '606812e63f78b']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "campaign data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}