Siųsti pavienę SMS

Siųsti pavienę SMS labai paprasta ir integracija turėtų užtrukti tik kelias sekundes.

Naudojant Connect klientų bibliotekas

Paprasčiausias būdas siųsti SMS yra naudojant mūsų oficialias klientų bibliotekas.

.NET

// Įterpkite IConnectSms per priklausomybių injekciją arba sukurkite rankiniu būdu:
// var smsClient = new ConnectClientBuilder()
//     .WithApiKey("jūsų-api-raktas")
//     .BuildSmsClient();

await smsClient.SendSmsAsync(new ConnectSmsMessage
{
    To = "+37060000000",         // Privaloma: E.164 formatas
    From = "JūsųSiuntėjas",      // Neprivaloma, jei DefaultSmsSender sukonfigūruotas
    Content = "Jūsų patvirtinimo kodas yra 123456"
});

Papildomos parinktys

await smsClient.SendSmsAsync(new ConnectSmsMessage
{
    To = "+37060000000",
    Content = "Jūsų susitikimas yra rytoj 10 val.",

    // Suplanuoti vėlesniam laikui (neprivaloma)
    DateSendAtUtc = DateTime.UtcNow.AddHours(1),

    // Sekti atsiskaitymui/analitikai (neprivaloma)
    ClientReference = "susitikimo-priminimas-123",

    // Perrašyti darbo erdvės nuorodų trumpinimo nustatymą šiai žinutei (neprivaloma)
    EnableLinkShortening = true,

    // Kontroliuoti unicode apdorojimą (neprivaloma, numatytoji reikšmė Allow)
    UnicodeMode = UnicodeMode.Allow  // Allow, Deny arba Strip
});

Naudojant šablonus

await smsClient.SendSmsAsync(new ConnectSmsMessage
{
    To = "+37060000000",
    TemplateName = "verification-code",
    TemplateData = new Dictionary<string, object>
    {
        ["code"] = "123456",
        ["expiresIn"] = "10 minučių"
    }
});

Note

Žr. Pradžia dėl įdiegimo ir nustatymo instrukcijų.

Node.js

import { ConnectClient } from '@divergent/connect';

const client = new ConnectClient({
  apiKey: process.env.DIVERGENT_CONNECT_API_KEY,
  defaultSmsSender: 'JūsųSiuntėjas'
});

const result = await client.sms.send({
  to: '+37060000000',            // Privaloma: E.164 formatas
  from: 'JūsųSiuntėjas',         // Neprivaloma, jei defaultSmsSender sukonfigūruotas
  content: 'Jūsų patvirtinimo kodas yra 123456'
});

console.log('Žinutės ID:', result.id);
console.log('Šalies kodas:', result.countryCode);

Papildomos parinktys

const result = await client.sms.send({
  to: '+37060000000',
  content: 'Jūsų susitikimas yra rytoj 10 val.',

  // Suplanuoti vėlesniam laikui (neprivaloma)
  sendAt: new Date(Date.now() + 60 * 60 * 1000),  // 1 valanda nuo dabar

  // Sekti atsiskaitymui/analitikai (neprivaloma)
  clientReference: 'susitikimo-priminimas-123',

  // Perrašyti darbo erdvės nuorodų trumpinimo nustatymą šiai žinutei (neprivaloma)
  enableLinkShortening: true,

  // Kontroliuoti unicode apdorojimą (neprivaloma)
  unicodeMode: 'allow'  // 'allow', 'deny' arba 'strip'
});

Naudojant šablonus

const result = await client.sms.send({
  to: '+37060000000',
  templateName: 'verification-code',
  templateData: {
    code: '123456',
    expiresIn: '10 minučių'
  }
});

Note

Žr. Pradžia dėl įdiegimo ir nustatymo instrukcijų.

---

REST API nuoroda

POST

/sms/send

Užklausos duomenys

Antraštės

X-Api-Key

required

string

API raktas jūsų darbo erdvei.

JSON duomenys

sender

required

string

Siuntėjo vardas SMS.

recipient

required

string

format: E.164

Gavėjo numeris (E.164 formatu) SMS.

content

required

string

Siunčiamos SMS turinys.

sendAtUtc

string

format: date-time (ISO 8601)

Data (UTC) ISO 8601 formatu, kada SMS turėtų būti suplanuota. Jei nenurodyta, SMS bus išsiųsta iš karto.

clientReference

string

Jūsų pačių nuoroda žinutei, naudinga atsiskaitymui, analitikai ir webhook pristatymo ataskaitų susiejimui su jūsų sistema.

unicode

string

Valdo, kaip apdorojami Unicode simboliai. Galimos reikšmės: Allow, Deny ir Strip.

enableLinkShortening

boolean

Perrašo jūsų darbo erdvės nuorodų trumpinimo nustatymą šiai žinutei. Nustatykite true, kad įjungtumėte nuorodų trumpinimą šiam siuntimui, arba false, kad išjungtumėte.

Atsakymo duomenys

JSON duomenys

id

string

format: long / int64

SMS ID iš Connect.

countryCode

string

Šalies kodas, išgautas iš telefono numerio.

Integracijos pavyzdys

Įklijuokite tai į savo mėgstamą terminalą, kad išsiųstumėte pirmąją SMS. Nepamirškite pakeisti reikiamų dalykų.

cURL

Siuntimas su cURL

curl -X POST https://connect-api.divergent.cloud/sms/send \
-H "X-Api-Key: { API_KEY }" \
--json '{
  "sender": "{ SENDER_NAME }",
  "recipient": "{ RECIPIENT_NUMBER }",
  "content": "{ CONTENT }",
  "enableLinkShortening": true
}'

PHP

<?php
$data = array(
  'sender' => '{ SENDER_NAME }',
  'recipient' => '{RECIPIENT_NUMBER}',
  'content' => '{ CONTENT }'
);
$api_key = '{ API_KEY }';
$json_data = json_encode($data);
$ch = curl_init('https://connect-api.divergent.cloud/sms/send');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type: application/json',
  'Content-Length: ' . strlen($json_data),
  'X-API-Key: ' . $api_key
));

$response = curl_exec($ch);
if (curl_errno($ch)) {
  throw new Exception(curl_error($ch));
}
curl_close($ch);