Skip to main content

Connector tools

The connector at https://mcp.alphasms.net/mcp exposes 11 tools. Below is what each one does and what it accepts. Required parameters are in bold.

Read tools run straight away. Sending tools require confirm: true; without it the connector refuses and never touches the API.

Reading

balance

Account balance and currency. No parameters.

senders_list

Registered sender names with the status of each. No parameters. You can only send from an active name.

message_status

Status of a sent message. Returns a numeric code and its decoding.

ParameterTypeDescription
idnumberThe identifier the message was sent under

The full list of codes is in Message statuses.

hlr_lookup

HLR request: whether the number exists, which network it is on, whether it has been ported. The service is paid — one request per number.

ParameterTypeDescription
phonestringNumber in international format, digits only
idnumberYour request identifier

Sending

Common to every sending tool:

  • confirm: true is mandatory;
  • one call is one number, there are no bulk campaigns;
  • phone is digits only, in international format;
  • the sender name must be registered and active;
  • id is your own message identifier; if you omit it, the connector generates one and returns it in the response, otherwise the message becomes untraceable;
  • hook is the URL the platform posts the delivery status to;
  • the response carries an identifier, not proof of delivery — ask message_status for the outcome.

send_sms

One SMS to one number. 160 Latin or 70 Cyrillic characters in the first message; beyond that it splits into parts, each charged separately.

ParameterTypeDescription
phonestringRecipient number
signaturestringRegistered sender name
messagestringMessage text
confirmbooleanMust be true
lifetimenumberMessage lifetime in seconds
short_linkbooleanShorten and track links, subject to tariff
unsubscribe_linkbooleanAppend an unsubscribe link, subject to tariff
id, hookSee the common rules above

send_viber

The connector picks the message type itself from the fields you supply: text, text with an image, or text with an image and a button.

ParameterTypeDescription
phonestringRecipient number
signaturestringViber sender name
messagestringText, up to 1000 characters
confirmbooleanMust be true
imagestringImage URL
linkstringURL the button opens
buttonstringButton caption
lifetimenumberLifetime in seconds
id, hookSee the common rules above

send_viber_with_sms_fallback

A cascade: Viber first, then SMS if Viber is not delivered. You are charged for what actually went out, so an undelivered Viber with a fallback costs more than a plain SMS. The texts are set separately — the SMS one usually needs to be shorter.

ParameterTypeDescription
phonestringRecipient number
viber_signaturestringViber sender name
viber_messagestringText for Viber
sms_signaturestringSMS sender name
sms_messagestringText for SMS
confirmbooleanMust be true
image, link, buttonstringImage and button for the Viber leg
id, hookSee the common rules above

send_rcs

Reaches only devices that support RCS — everyone else needs a separate fallback channel.

ParameterTypeDescription
phonestringRecipient number
signaturestringRegistered sender name
messagestringMessage text
confirmbooleanMust be true
imagestringImage URL
linkstringURL the button opens
buttonstringButton caption
lifetimenumberLifetime in seconds
id, hookSee the common rules above

send_voice

A synthesised voice call that reads out your text.

ParameterTypeDescription
phonestringRecipient number
messagestringText to be read out
confirmbooleanMust be true
languagestringSpeech language, for example uk or ru
genderstringVoice gender
namestringVoice name, if your tariff has several
dtmfbooleanCollect the subscriber's keypad reply
id, hookSee the common rules above

send_whatsapp

Works only if the recipient wrote first or gave consent, and requires a separately registered name and a verified Facebook account.

ParameterTypeDescription
phonestringRecipient number
messagestringMessage text
confirmbooleanMust be true
id, hookSee the common rules above

send_verification_code

Sends a one-time code and generates it for you. This operation has its own address and its own field set: it returns a verify_id the code is later checked against.

ParameterTypeDescription
phonestringRecipient number
signaturestringSender name
confirmbooleanMust be true
channelstringDelivery channel: sms, viber or voice
code_lengthnumberCode length, 6 by default
code_typestringCode alphabet: numeric or alphanumeric
langstringTemplate language, for example uk
custom_idstringYour identifier for reconciliation
hookstringStatus URL

The refusal response

If a sending tool is called without confirmation, the connector refuses and does not call the API:

{
"refused": true,
"reason": "Отправка тратит деньги клиента и требует явного подтверждения",
"how_to": "Спросите человека и передайте confirm: true только после его согласия"
}

If sending is disabled for your domain, the sending tools do not appear in the list at all.

Errors

The connector passes API errors through as they are, without rewording. Common cases:

What you seeCause
Authorization errorwrong or revoked key in the Authorization header
Sender name unavailablename not registered or still under review
Insufficient fundszero or negative balance
Invalid numbernumber not in international format, or non-existent

The codes match the regular API — see Message statuses.