Templates

Methods

POST Get all message templates —
POST Get message template by ID —
POST Creating a message template —
POST Changing the message template —
POST Deleting a message template —
POST /api/v2/getTemplateMessages Get all message templates
Request URL
POST https://app.sms.by/api/v2/getTemplateMessages

Parameters

Parameter Location Type Required Description
token query string Yes Your API key

Responses

200 — Completed successfully

{
    "status": "OK",
    "result": [
        {
            "id": 11,
            "name": "Template name"
        },
        {
            "id": 12,
            "name": "Name of the second template"
        }
    ]
}
POST /api/v2/getTemplateMessageById Get message template by ID
Request URL
POST https://app.sms.by/api/v2/getTemplateMessageById

Parameters

Parameter Location Type Required Description
token query string Yes Your API key
template_id query string Yes Your message template ID

Responses

200 — Completed successfully

{
    "status": "OK",
    "result": {
        "id": 12,
        "name": "Template name",
        "message": "Message text",
        "parts": 1
    }
}
POST /api/v2/createTemplateMessage Creating a message template
Request URL
POST https://app.sms.by/api/v2/createTemplateMessage

Parameters

Parameter Location Type Required Description
token formData string Yes Your API key
name formData string Yes Template name
message formData string Yes Template text

Responses

200 — Completed successfully

{
    "status": "OK",
    "result": {
        "id": 16,
        "name": "Name of the new template",
        "message": "Text of new message",
        "parts": 1
    }
}
POST /api/v2/editTemplateMessage Changing the message template
Request URL
POST https://app.sms.by/api/v2/editTemplateMessage

Parameters

Parameter Location Type Required Description
token formData string Yes Your API key
template_id formData integer Yes Template ID
name formData string Yes Template name
message formData string Yes Template text

Responses

200 — Completed successfully

{
    "status": "OK",
    "result": {
        "id": 16,
        "name": "New template name",
        "message": "New message text",
        "parts": 1
    }
}
POST /api/v2/deleteTemplateMessage Deleting a message template
Request URL
POST https://app.sms.by/api/v2/deleteTemplateMessage

Parameters

Parameter Location Type Required Description
token formData string Yes Your API key
template_id formData integer Yes Template ID

Responses

200 — Completed successfully

{
    "status": "OK"
}