API docs by Redocly

Yazsana Customer API (1.0.0)

Download OpenAPI specification:

Sms Sendings

Send One

header Parameters
x-api-key
string
Example: {{API_KEY}}
Request Body schema: application/json
to
string

Phone number

message
string

Message text

Responses

Request samples

Content type
application/json
{
  • "to": "905550000000",
  • "message": "Your confirmation code is: 123456"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": "f688348d-2d9b-4568-a17e-b96e6b5c1475"
}

List sms sendings

query Parameters
page
required
integer >= 1
Example: page=1

Response page

limit
required
integer >= 0
Example: limit=100

Number of items per page

startDate
string <date-time>
Example: startDate=2025-12-03T00:00:00Z
endDate
string <date-time>
Example: endDate=2025-12-10T00:00:00Z
completed
boolean
Example: completed=true
text
string
Example: text=code
header Parameters
x-api-key
string
Example: {{API_KEY}}

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Send Simple

header Parameters
x-api-key
string
Example: {{API_KEY}}
Request Body schema: application/json
to
Array of strings

List of phone numbers

message
string

Message text

Responses

Request samples

Content type
application/json
{
  • "to": [
    ],
  • "message": "Your confirmation code is: 123456"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": "410bc79f-f751-46b9-9b93-ceb3fdcea049"
}

Send Advanced

header Parameters
x-api-key
string
Example: {{API_KEY}}
Request Body schema: application/json
Array
to
string

Phone number

message
string

Message text

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "data": "cebbe29a-e9e3-42f0-ad1b-12c99bca067d"
}

Get sms sending

path Parameters
id
required
string
Example: cebbe29a-e9e3-42f0-ad1b-12c99bca067d
header Parameters
x-api-key
any
Example: {{API_KEY}}

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

List sms sending messages

path Parameters
id
required
string
Example: cebbe29a-e9e3-42f0-ad1b-12c99bca067d
query Parameters
page
required
integer >= 1
Example: page=1

Response page

limit
required
integer >= 0
Example: limit=100

Items per page

status
string
Enum: "sent" "not_sent" "failed" "waiting" "no_signal" "pending"
Example: status=pending

Message status

text
string
Example: text=code

Message text

header Parameters
x-api-key
any
Example: {{YAZSANA_API_KEY}}

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Users

Get me

header Parameters
x-api-key
any
Example: {{API_KEY}}

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}