SendSMS

post

https://restapi.payplus.co.il/api/v1.0/SMS/SendSMS

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Name of the message

sms_sender_uid

string

Should be active sender name. Can be use only for SMS

groups_uid

array of strings

[a22015eb-1c21-2d2c-b385-662a97d3e5da] (array,optional) - One of the parameters groups_uid, contacts_uid, phones should be send

groups_uid

contacts_uid

array of strings

contacts_uid

phones

array of strings

phones

type

string

required

content

string

required

Content of the SMS or TTS message

generate_short_links

boolean

If you would like we will create shortcut for all your links in your message content

agreement_signed

boolean

required

You must approve our terms and conditions for every sending of message

show_unsubscribe_link

boolean

To show unsubscribe link at the end of the SMS message type only

unsubscribe_link_title

string

What is the word to show in the message to unsubscribe

callback_url

string

string URL to receive SMS notifications with sending status, URL must be secure [HTTPS] and the data will be sent using POST method. SMS response can be found in the next method.

send_settings

object

required

Headers

api-key

string

required

API Key

secret-key

string

required

Secret Key

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400