Tài liệu

Gửi tin nhắn đầu tiên của bạn vào một buổi chiều

API REST đơn giản để gửi, theo dõi và nhận SMS — xác thực mã thông báo, webhook và SDK thời gian thực, không có gì lạ để tìm hiểu.

Bắt đầu nhanh

Ba bước, bắt đầu giao hàng

Mọi tích hợp đều có cùng một vòng cung ngắn — xác thực, gửi và sau đó theo dõi.

01 · Xác thựcMã thông báo: sk_live_9f2a7c10Loại nội dung: ứng dụng/json ✓

Gửi khóa truy cập của bạn dưới dạng tiêu đề Mã thông báo, với Content-Type: application/json, theo mọi yêu cầu.

02 · GửiBÀI ĐĂNG/bên ngoài/sms{ msgid: "9f2a7c10", mã lỗi: 0 }

ĐĂNG một từ, đến và nội dung. Phản hồi sẽ trả về ngay lập tức kèm theo msgid và mã lỗi.

03 · Theo dõiNHẬN /báo cáo?status=Delivrd200 được rồi

Chúng tôi ĐĂNG hoặc NHẬN báo cáo trạng thái tới URL gọi lại của bạn ngay khi tin nhắn đạt đến trạng thái cuối cùng.

Gửi

Một yêu cầu, bằng ngôn ngữ bạn đã sử dụng

ĐĂNG người gửi, người nhận và nội dung của bạn bằng tiêu đề Mã thông báo. Phản hồi sẽ quay trở lại ngay lúc chúng ta chấp nhận nó.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · Đã chấp nhận

msgstr "9f2a7c10-4b2e-..."

phương hướng "mt"

mã lỗi 0

Lưu msgstr - đó là cách bạn theo dõi tin nhắn này từ đây.

Đối tượng tin nhắn

Đọc tin nhắn từ trên xuống dưới

Các sự kiện gửi, trạng thái và gửi đến đều có cùng hình dạng — hãy tìm hiểu một lần.

01ID tin nhắn

ID tin nhắn

msgid — được thực hiện vào thời điểm tin nhắn được tạo. Đây là tay cầm bạn sử dụng để kiểm tra trạng thái của nó sau này.

02Người gửi

Người gửi

từ — một số điện thoại hoặc ID chữ và số tối đa 11 ký tự, bất kể danh tính nào mà người nhận của bạn nhìn thấy.

03Người nhận

Người nhận

tới - số mà tin nhắn sẽ gửi đến, bao gồm cả mã quốc gia.

04Mã hóa

Mã hóa

mã hóa dữ liệu - GSM7 phù hợp với 160 ký tự mỗi phần; chuyển sang Unicode và giảm xuống còn 70. Đi qua và nó ghép thành các phần được tính phí bổ sung.

05Phương hướng

Phương hướng

hướng - mọi tin nhắn đều là mt (bạn đã gửi nó) hoặc mo (bạn đã nhận được nó), cả hai đều có hình dạng giống nhau.

06Mã lỗi

Mã lỗi

mã lỗi - được trả về khi gửi phản hồi và mọi báo cáo trạng thái. 0 có nghĩa là được chấp nhận; bất cứ điều gì khác cho bạn biết chính xác những gì đã xảy ra.

Thẩm quyền giải quyết

Một điểm cuối, hai động từ

POST để gửi, NHẬN để kiểm tra trạng thái — cùng một URL và cùng một tiêu đề Mã thông báo.

BƯU KIỆN

Gửi

Gửi tin nhắn và nhận lại ngay một msgid và mã lỗi.

Trả lại msgstr + mã lỗi
LẤY

Theo dõi

Tra cứu tin nhắn bạn đã gửi để kiểm tra trạng thái hiện tại của nó.

Trả lại tin nhắn + trạng thái
Webhook

Báo cáo trạng thái, thời điểm chúng xảy ra

Đặt URL gọi lại và mỗi lần gửi, trả lời thất bại và trả lời gửi đến sẽ chuyển đến đó dưới dạng GET hoặc POST — không cần thăm dò ý kiến.

đã giao hàngmsgid 9f2a7c10 · trạng thái Delivrd
hướng tớiđã nhận được trả lời · hướng mo
thất bạimsgstr 4c81e2 · trạng thái Thất bại
Điểm cuối của bạn200 được rồi
Bắt đầu

Nhận khóa API của bạn

Bắt đầu tích hợp sau vài phút với API REST của chúng tôi.

Câu trả lời cho câu hỏi của bạn

Tài liệu dành cho nhà phát triển - câu hỏi thường gặp

Chuyển khóa truy cập của bạn vào tiêu đề Mã thông báo cho mọi yêu cầu — Mã thông báo: {accessKey} — cùng với Loại nội dung: application/json.

Mỗi lần gửi đều trả về một msgid. Chỉ cho chúng tôi một URL gọi lại và chúng tôi ĐĂNG hoặc NHẬN báo cáo trạng thái cho URL đó ngay khi tin nhắn đạt đến trạng thái cuối cùng - ngày phụ, ngày hoàn thành và mã trạng thái kết quả được bao gồm.

mt (điện thoại di động đã kết thúc) là tin nhắn bạn đã gửi; mo (có nguồn gốc từ thiết bị di động) là câu trả lời bạn nhận được. Cả hai đều sử dụng hình dạng đối tượng tin nhắn giống nhau.

Việc phân phối được thử lại theo chính sách thử lại — không có gì bị loại bỏ một cách âm thầm, nhưng điểm cuối không bao giờ thừa nhận sẽ tiếp tục nhận được các lần thử lại.

160 ký tự trên mã hóa GSM7 hoặc 70 ký tự trên Unicode. Vượt quá giới hạn và tin nhắn sẽ được ghép thành nhiều phần, mỗi phần sẽ được tính phí riêng.