Passa al contenuto principale

SmsMessageResponse

Successful response with one SmsMessage

errorintegerrequired

Always 0 in a successful response

Constant value: 0
messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Message of an SMS sending to one recipient, with its delivery data

idintegerrequired
sms_idintegerrequired

Id of the SMS sending (GET /api/v3/sms/{sms_id})

sms_price objectrequired

Price list of the destination country; null for sub-accounts

anyOf
country objectrequired
iso_code_2stringrequired

ie. IT

iso_code_3stringrequired

ie. ITA

country_namestringrequired

Name of the country in Italian; the local name when there is no translation

local_namestringrequired

Name of the country in its own language, for example Deutschland

phone_codestringrequired

International calling code, without +, for example 39

continentstringrequired

Continent, in English, for example Europe or North America

regionstringrequired

Area of the country: EU (European Union) or EXTRAEU

standard_price objectrequired

Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise

amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

premium_price objectrequired

Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise

amountfloatnullablerequired

Taxable amount

currencystringrequired

Currency code: always EUR

tax_ratefloatnullablerequired

VAT rate as a fraction, for example 0.22 for 22%

taxfloatnullablerequired

VAT (tax) amount

totalfloatnullablerequired

Total amount

valid_fromdate-timenullablerequired

Date and time from which these prices apply

contact_namestring | nullnullablerequired

Surname and name of the recipient, when taken from a phonebook; otherwise empty or null

phone_numberstringrequired

Phone number of the recipient in international format with the 00 prefix, for example 00393331122444

date_sentdate-timenullablerequired

Date and time the message was sent; null until it is sent

date_delivereddate-timenullablerequired

Date and time the message was delivered; null until the delivery is confirmed

errorstring | nullnullablerequired

Error code if the SMS was not delivered

metarequired

Always null: only the paginated lists have a meta

Constant value: null
SmsMessageResponse
{
"error": 0,
"message": "string",
"data": {
"id": 0,
"sms_id": 0,
"sms_price": {
"country": {
"iso_code_2": "string",
"iso_code_3": "string",
"country_name": "string",
"local_name": "string",
"phone_code": "string",
"continent": "string",
"region": "string"
},
"standard_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"premium_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"valid_from": "2024-07-29T15:51:28.071Z"
},
"contact_name": "string",
"phone_number": "string",
"date_sent": "2024-07-29T15:51:28.071Z",
"date_delivered": "2024-07-29T15:51:28.071Z",
"error": "string"
}
}