Dokumentasi API Verifikasi SMS

Versi - 1.0
info

Harap dicatat bahwa Anda akan memerlukan bantuan tim kami untuk memulai kampanye SMS Anda bahkan setelah integrasi API. Jadi, minta Anda untuk Hubungi setelah integrasi.

Pendahuluan

Message Now adalah API perpesanan serbaguna yang dirancang untuk memfasilitasi pengiriman pesan melalui SMS dan RCS.

Bantuan & Dukungan

Untuk dukungan implementasi dan umpan balik apa pun, silakan hubungi kami di: support@messagecentral.com

Parameter API untuk Verifikasi Sekarang

API Parameter
Type
Value
flowType
String
SMS/WHATSAPP/
RCS/SAUTH
type
String
OTP

URL Dasar API Rest

Semua titik akhir API Platform di bawah ini harus diawali dengan URL berikut:

  1. Mengirim Pesan ke Nomor Tunggal

    • Untuk mengirim pesan ke satu nomor, isi bidang API berikut:

    • MobileNumber: Nomor ponsel penerima.

    • Pesan: Isi teks dari pesan yang akan dikirim.

  2. Mengirim Pesan ke Beberapa Nomor 


    Ada dua metode untuk mengirim pesan ke beberapa nomor:

a. Menggunakan Unggahan File Multipart

  • Unggah File: Gunakan parameter API (file) untuk mengunggah file multipart.

  • Pesan: Gunakan parameter API (pesan) untuk teks yang akan dikirim.

  • Format File: Hanya file.xlsx yang didukung.

  • Kustomisasi: Metode ini mendukung pesan yang disesuaikan per pengguna, memungkinkan konten pesan yang berbeda untuk setiap penerima yang tercantum dalam file.

b. Menggunakan Bidang API untuk Beberapa Nomor

  • PhoneNumbers: Gunakan parameter API (PhoneNumbers) untuk menentukan daftar nomor penerima. (format: <space>ponsel negara: Misalnya - 91 9816111111, 91 7715131105,...)

  • Pesan: Gunakan parameter API (pesan) untuk teks yang akan dikirim.

  • Format File: Hanya file.xlsx yang didukung.

  • Kustomisasi: Metode ini mendukung pesan yang disesuaikan per pengguna, memungkinkan konten pesan yang berbeda untuk setiap penerima yang tercantum dalam file.

Perbedaan Antara Upload File Multipart dan Bidang Nomor Telepon:

  • Unggahan File Multipart (.xlsx): Memungkinkan pesan yang disesuaikan per pengguna. Setiap penerima dapat menerima pesan unik seperti yang ditentukan dalam file.xlsx yang diunggah.

  • Bidang PhoneNumbers: Mengirim teks yang sama ke semua penerima. Pesan yang ditentukan di bidang pesan akan dikirimkan secara seragam ke semua orang yang terdaftar di bidang PhoneNumbers.

Silakan temukan format file sampel dalam format XLXS di bawah ini:

Country
Mobile
Var1
Var2
Var3
91
12345678901
Amit
$35
DISOUNT20
91
23456789012
Kunal
$60
DISOUNT20
91
12345678901
Prakash
$35
DISOUNT20

Dimana 'var1', 'var2', dan 'var3' adalah placeholder untuk variabel.

Jika perusahaan ingin mengirim pesan khusus menggunakan unggahan file, bidang pesan harus diformat sebagai berikut:

Contoh pesan - “Halo # #var ##, saldo Anda adalah # #var2 ## pada tanggal # #var3 ##

Raih Kesempatan

Jika Anda seorang pengembang atau agen pengembangan web, bermitra dengan kami untuk mempercepat penghasilan Anda.

Menjadi Mitra
css-image

Kirim SMS

Request Header
Type
Mandatory?
authToken
String
SMS/WHATSAPP/
RCS/SAUTH

Untuk mengirim SMS ke nomor ponsel, parameter permintaan berikut diperlukan. Token otentikasi, yang dihasilkan oleh API pembuatan token, diperlukan untuk mengirim SMS.

https://cpaas.messagecentral.com

Saat menggunakan API verifikasi SMS Verify Now untuk mengirim kode verifikasi SMS, panggilan awal harus ke API pembuatan token.

API ini mengembalikan token yang harus disertakan dalam semua panggilan berikutnya. Token otentikasi diperlukan untuk memvalidasi pengguna dan harus dimasukkan dalam bagian header dari setiap permintaan.

Field
Type
Mandatory?
Description
customerId
String
yes
Customer identifier (need to signup to get your  customer id)
country
String
no
Country code to send OTP to
email
String
no
Email
key
String
String
Base-64 encrypted password
scope
String
no
Use ‘NEW’ for first time

Meminta Jalur URL:

Respons yang berhasil akan mengembalikan kode status 200.

/verification/v3/send

Parameter Permintaan:

Respons yang berhasil akan mengembalikan kode status 200.

Field
Type
Mandatory?
Description
type
String
yes
Use “SMS” while sending SMS
file
xlxs
no
This needs to be sent as form data
countryCode
String
Yes (in case of single SMS & Verify Now)
CountryCode
otpLength
Integer
No
Base-64 encrypted password
mobileNumber
String
Yes (in case of single SMS)
Mobile number for single text
flowType
String
Yes
Send “SMS”
messageType
String
No (default is OTP)
The type of message to be sent (Allowed values are TRANSACTION, PROMOTIONAL, OTP)
senderId
String
Yes (in case of SMS)
ID of the sender
phoneNumbers
String
No
A list of phone numbers to send the SMS (format: country <space>mobile : 
91  9876111111)
message
String
No
The custom message to be sent
templateId
String
No
Template Id of your approved template
entityId
String
No
Entity Id of your brand

CATATAN: TemplateID dan EntityId diperlukan jika template tidak terdaftar dengan Pusat Pesan. Juga, TemplateID dan EntityId harus ada atau keduanya harus tidak ada.

cURL

1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send?countryCode=91&flowT ype=SMS&mobileNumber=9999999999&senderId=UTOMOB&type=SMS&message=%3CYour%20 Message%20Template%3E&messageType=PROMOTIONAL' \--header 'authToken: eyJhbGciOiJIUzUxMiJ9.thisisatesttoken.IgGu7Sb4lovBSql5LIXZU3jlwPG4giAMZ2kTI Mg_EAaKVsVcCdpW_TYzyzdTd94GdEJMt5WntEGcEX4w0hITng'

CATATAN: Untuk mengubah perintah cURL menjadi kode menggunakan Postman, buka Postman, impor perintah cURL melalui tombol “Impor”, lalu buat kode dalam bahasa pilihan Anda dengan mengklik tombol “Kode” di sisi kanan permintaan.

Tanggapan JSON

Respons yang berhasil akan mengembalikan kode status 200.

1{
2	"responseCode": 200,
3	"message": "SUCCESS",
4	"data": {
5		"verificationId": "1234",
6		"mobileNumber": "9999999999",
7		"responseCode": "200",
8		"errorMessage": null,
9		"timeout": "30.0",
10		"smsCLI": null,
11		"transactionId": "1c9c56ec-5cd3-48b5-9e32-a15499fb77a2"
12	}
13}

Contoh Kode

curl --location 'https://cpaas.messagecentral.com/verification/v3/send?countryCode=91&flowType=SMS&mobileNumber=9999999999&senderId=UTOMOB&type=SMS&message=%3CYour%20Message%20Template%3E&messageType=PROMOTIONAL' \
--header 'authToken: eyJhbGciOiJIUzUxMiJ9.thisisatesttoken.IgGu7Sb4lovBSql5LIXZU3jlwPG4giAMZ2kTIMg_EAaKVsVcCdpW_TYzyzdTd94GdEJMt5WntEGcEX4w0hITng' \
--form 'file=@"/C:/Users/Kunal Suryawanshi/Downloads/Sample_MessageNow.xlsx"'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com")
  .method("GET", body)
  .addHeader("accept", "*/*")
  .build();
Response response = client.newCall(request).execute();
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com',
  'headers': {
    'accept': '*/*'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'accept' => '*/*'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
import requests

url = "https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com"

payload = {}
headers = {
  'accept': '*/*'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
require "uri"
require "net/http"

url = URI("https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "*/*"

response = https.request(request)
puts response.read_body

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com");
request.Headers.Add("accept", "*/*");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Kirim OTP

Untuk SendOTP pada nomor ponsel di bawah ini adalah parameter permintaan. Token otentikasi diperlukan untuk mengirim OTP yang dihasilkan oleh token API yang dihasilkan (yang dapat Anda temukan di atas di bagian Pendahuluan).

1. Informasi yang Diperlukan:
a. ID Pelanggan
b. Nama Merek
c. ID Email Terdaftar
d. URL Panggilan Balik

2. Instruksi Pengiriman: Silakan kirim informasi di atas ke operations@messagecentral.com dengan baris subjek “Integrasi Panggilan Balik SMS dengan Pusat Pesan.

3. Spesifikasi URL Panggilan Balik: Pastikan URL panggilan balik Anda dapat diakses dan mampu menerima permintaan HTTP POST yang berisi muatan JSON dengan pembaruan status pesan SMS yang dikirim. Setelah dipicu, titik akhir akan menerima muatan JSON berikut.

1{ 
2"apiKey": null, 
3"clientId": null, 
4"messageId": "a2e87214-d18c-4a2e-b7f4-802c4465a9b9", 
5"status": "DELIVRD", 
6"errorCode": 0, 
7"countryCode": null, 
8"mobile": "919999999999", 
9"submitDate": "2023-11-02 13:59:18", 
10"doneDate": "2023-11-02 13:59:22" 
11}

4. Status Standar: Ini adalah status berikut yang akan Anda terima untuk semua pesan yang dikirim.
a.DELIVRD 

b. KEDALUWARSA
c. UNDELIV
d. TIDAK DIKETAHUI
e. DITOLAK

Untuk bantuan atau klarifikasi lebih lanjut, silakan hubungi tim dukungan kami di: -support@messagecentral.com

Siap untuk memulai?

Lindungi akun pengguna Anda dan bangun kepercayaan dengan pelanggan Anda menggunakan verifikasi SMS. Coba Verifikasi Sekarang tanpa kartu kredit.

Message Central Logo Blue
Close Icon
Tim Pusat Pesan
Halo
Bagaimana kami bisa membantu Anda hari ini?
WhatsApp Icon
Mulai Obrolan Whatsapp
Obrolan WhatsApp
WhatsApp Icon