API Users
All operations require authentication.
List usersProduction
List users. Returns the logins of the API users of the SMS account. Each user sends SMS with its own login, callback URLs, quota and IP restrictions.
Path parameters
The internal name of your SMS offer
Response
Example uses serviceName = string
$ curl https:/[ "string"]
Get a userProduction
Get a user. Returns the API user: login, callback URLs, quota left and status, alert threshold and the IP addresses allowed to send SMS.
Path parameters
The sms user login
The internal name of your SMS offer
Response
A structure describing all information about alert threshold informations
URL called when state of a sent SMS changes
The sms user login
A structure describing all information about quota informations
URL called when a STOP is received after a receiver replied stop to a SMS
Example uses login = string, serviceName = string
$ curl https:/{ "alertThresholdInformations": { "alertEmail": "string", "alertNumber": "string", "alertThreshold": 0, "support": "both" }, "callBack": "string", "ipRestrictions": [ "string" ], "login": "string", "password": "string", "quotaInformations": { "quotaLeft": 0, "quotaStatus": "active" }, "stopCallBack": "string"}
Create a userProduction
Create a user. Creates an API user with a login and a password, to send SMS with its own callback URLs, quota and IP restrictions.
Path parameters
The internal name of your SMS offer
Request body (required)
The sms login
The sms password
Response
Example uses serviceName = string
$ curl https:/Delete a userProduction
Delete a user. Deletes the API user of the SMS account. Its login and password can no longer be used to send SMS.
Path parameters
The sms user login
The internal name of your SMS offer
Response
Example uses login = string, serviceName = string
$ curl https:/Update a userProduction
Update a user. Updates the API user: password, callback URLs, quota, alert threshold and the IP addresses allowed to send SMS.
Path parameters
The sms user login
The internal name of your SMS offer
Request body (required)
A structure describing all information about alert threshold informations
URL called when state of a sent SMS changes
The sms user login
A structure describing all information about quota informations
URL called when a STOP is received after a receiver replied stop to a SMS
Response
Example uses login = string, serviceName = string
$ curl https:/Export SMS to a documentProduction
Export SMS to a document. Generates a document with the SMS of the account, filtered by tag, date, direction or batch. Returns the identifier of the document in /me/document.
Path parameters
The sms user login
The internal name of your SMS offer
Query parameters
Filter the value of creationDatetime property (>=)
Filter the value of creationDatetime property (<=)
Select sms with a specific identifier group tag
specify outgoing or incoming sms
incomingoutgoingResponse
Example uses login = string, serviceName = string
$ curl https:/"string"
List received SMSProduction
List received SMS. Returns the identifiers of the received SMS. Get a received SMS for its sender, message, date and credits used.
Path parameters
The sms user login
The internal name of your SMS offer
Query parameters
Filter the value of sender property (=)
Filter the value of tag property (=)
Response
Example uses login = string, serviceName = string
$ curl https:/[ 0]
Get a received SMSProduction
Get a received SMS. Returns the received SMS: sender, message, reception date, credits used and tag. The tag groups SMS for filtering and export.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
Example uses id = 0, login = string, serviceName = string
$ curl https:/{ "creationDatetime": "2024-01-01T12:00:00Z", "credits": 0, "id": 0, "message": "string", "sender": "string", "tag": "string"}
Delete a received SMSProduction
Delete a received SMS. Deletes the received SMS from the history. It no longer appears in the list of received SMS.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
Example uses id = 0, login = string, serviceName = string
$ curl https:/List pending jobsProduction
List pending jobs. Returns the identifiers of the SMS waiting to be sent. Get a pending job for its receiver, message, number of SMS parts and credits.
Path parameters
The sms user login
The internal name of your SMS offer
Response
Example uses login = string, serviceName = string
$ curl https:/[ 0]
Get a pending jobProduction
Get a pending job. Returns the SMS waiting to be sent: receiver, message, number of SMS parts and credits.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
Example uses id = 0, login = string, serviceName = string
$ curl https:/{ "creationDatetime": "2024-01-01T12:00:00Z", "credits": 0, "deliveredAt": "2024-01-01T12:00:00Z", "deliveryReceipt": 0, "differedDelivery": 0, "id": 0, "message": "string", "messageLength": 0, "numberOfSms": 0, "ptt": 0, "receiver": "string", "sender": "string", "sentAt": "2024-01-01T12:00:00Z"}
Send SMSProduction
Send SMS. Sends an SMS to one or several receivers, given as a list, a CSV document URL or a receiver list. Sending can be delayed, and a validity period drops the message if it is not delivered in time.
Path parameters
The sms user login
The internal name of your SMS offer
Request body (required)
The sms coding
UTF-8Deprecated: The sms class
flashphoneDisplaysimtoolkitDeprecated: the coding is deduced from the message and its charset
7bit8bitThe time -in minute(s)- to wait before sending the message
The sms message
Do not display STOP clause in the message, this requires that this is not an advertising message
The priority of the message
highlowmediumveryLowThe receivers list
The receivers document url link in csv format
The receivers document slot id
The sender
Set the flag to send a special sms which can be reply by the receiver (smsResponse).
The identifier group tag
The maximum time -in minute(s)- before the message is dropped
Response
Example uses login = string, serviceName = string
$ curl https:/{ "creditsLeft": 0, "ids": [ 0 ], "invalidReceivers": [ "string" ], "tag": "string", "totalCreditsRemoved": 0, "validReceivers": [ "string" ]}
Delete a pending jobProduction
Delete a pending job. Cancels the sending of an SMS that is still waiting to be sent, such as a delayed SMS. Sent SMS are in the sent SMS history.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
Example uses id = 0, login = string, serviceName = string
$ curl https:/List sent SMSProduction
List sent SMS. Returns the identifiers of the sent SMS. Get a sent SMS for its receiver, message, delivery status, number of SMS parts and credits used.
Path parameters
The sms user login
The internal name of your SMS offer
Query parameters
Filter the value of deliveryReceipt property (=)
Filter the value of differedDelivery property (=)
Filter the value of ptt property (=)
Filter the value of receiver property (=)
Filter the value of sender property (=)
Filter the value of tag property (=)
Response
Example uses login = string, serviceName = string
$ curl https:/[ 0]
Get a sent SMSProduction
Get a sent SMS. Returns the sent SMS: receiver, message, delivery status, number of SMS parts and credits used.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
Tariff code applied on the sms
Example uses id = 0, login = string, serviceName = string
$ curl https:/{ "creationDatetime": "2024-01-01T12:00:00Z", "credits": 0, "deliveredAt": "2024-01-01T12:00:00Z", "deliveryReceipt": 0, "differedDelivery": 0, "id": 0, "message": "string", "messageLength": 0, "numberOfSms": 0, "ptt": 0, "receiver": "string", "sender": "string", "sentAt": "2024-01-01T12:00:00Z", "tag": "string", "tariffCode": "string"}
Delete a sent SMSProduction
Delete a sent SMS. Deletes the sent SMS from the history. It no longer appears in the list of sent SMS of the user or number.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
Example uses id = 0, login = string, serviceName = string
$ curl https:/Get the receiver operatorProduction
Get the receiver operator. Returns the operator of the phone number, from the network query trace: country, country code, region, operator and network.
Path parameters
Id of the object
The sms user login
The internal name of your SMS offer
Response
The country
The countryCode prefix number
The network name
The operator name
The region
Example uses id = 0, login = string, serviceName = string
$ curl https:/{ "country": "string", "countryCode": "string", "network": "string", "operator": "string", "region": "string"}
List receiver listsProduction
List receiver lists. Returns the identifiers (slotId) of the receiver lists. A receiver list is a CSV or text document of numbers, used to send SMS in bulk.
Path parameters
The sms user login
The internal name of your SMS offer
Response
Example uses login = string, serviceName = string
$ curl https:/[ 0]
Get a receiver listProduction
Get a receiver list. Returns the receiver list: description, number of records and automatic update settings.
Path parameters
The sms user login
The internal name of your SMS offer
Slot number id
Response
Download file from URL before sending to contacts (works only with csvUrl and not document ID)
Is the object compatible with autoUpdate
Creation date of the document
Description name of the document
Number of receiver records in the document
Slot number id
Example uses login = string, serviceName = string, slotId = 0
$ curl https:/{ "autoUpdate": true, "canAutoUpdate": true, "datetime": "2024-01-01T12:00:00Z", "description": "string", "records": 0, "slotId": 0}
Create a receiver listProduction
Create a receiver list. Creates a receiver list from a CSV file, given as a /me/document identifier or a URL. With a URL, the file can be downloaded again before each sending.
Path parameters
The sms user login
The internal name of your SMS offer
Request body (required)
Download file from URL before sending to contacts (works only with csvUrl and not document ID)
URL of the file you want to import
Description name of the document
ID of the /me/document file you want to import
Slot number id used to handle the document
Response
Download file from URL before sending to contacts (works only with csvUrl and not document ID)
Is the object compatible with autoUpdate
Creation date of the document
Description name of the document
Number of receiver records in the document
Slot number id
Example uses login = string, serviceName = string
$ curl https:/{ "autoUpdate": true, "canAutoUpdate": true, "datetime": "2024-01-01T12:00:00Z", "description": "string", "records": 0, "slotId": 0}
Delete a receiver listProduction
Delete a receiver list. Deletes the receiver list. It can no longer be used as the receivers of an SMS sending (receiversSlotId).
Path parameters
The sms user login
The internal name of your SMS offer
Slot number id
Response
Example uses login = string, serviceName = string, slotId = 0
$ curl https:/Update a receiver listProduction
Update a receiver list. Updates the description of the receiver list and its automatic update, which downloads the file from its URL before each sending.
Path parameters
The sms user login
The internal name of your SMS offer
Slot number id
Request body (required)
Download file from URL before sending to contacts (works only with csvUrl and not document ID)
Is the object compatible with autoUpdate
Creation date of the document
Description name of the document
Number of receiver records in the document
Slot number id
Response
Example uses login = string, serviceName = string, slotId = 0
$ curl https:/Clean a receiver listProduction
Clean a receiver list. Removes the invalid and inactive numbers from the receiver list, with an HLR lookup on each number. A report is sent by email at the end.
Path parameters
The sms user login
The internal name of your SMS offer
Slot number id
Request body (required)
Limit checks to syntaxical validation
Only get action's price in credits without executing it
Response
Example uses login = string, serviceName = string, slotId = 0
$ curl https:/{ "taskId": 0, "totalCreditsRemoved": 0}
Get the receiver list CSVProduction
Get the receiver list CSV. Returns the content of the receiver list in CSV format. The number of records is given when getting the receiver list.
Path parameters
The sms user login
The internal name of your SMS offer
Slot number id
Response
Example uses login = string, serviceName = string, slotId = 0
$ curl https:/"string"