Tin nhắn SMS

API thông tin gửi tin nhắn SMS qua hệ thống CareSoft

Để gửi tin nhắn SMS trên CareSoft cần dịch vụ SMS Brandname đã được tích hợp vào tài khoản khách hàng.

Cách kiểm tra dịch vụ SMS đã được tích hợp lên hệ thống và lấy ID dịch vụ để thực hiện gửi SMS

Lập trình viên có thể sử dụng API SMS tích hợp vào hệ thống CRM/ERP để thực hiện các nghiệp vụ nhắn tin báo số dư, báo trạng thái đơn hàng cho khách hàng theo bối cảnh thực tế.

Thông tin trường dữ liệu SMS

STT	Tên trường	Kiểu dữ liệu	Ý nghĩa
1	service_id	INT	ID dịch vụ SMS đã tích hợp trên hệ thống CareSoft
2	content	STRING (1000)	Nội dung tin nhắn gửi đi
3	phone	TELEPHONE	Số điện thoại nhận SMS
4	ticket_id	INT	ID phiếu ghi trong trường hợp cần gán vào phiếu ghi đã có từ trước

Mẫu json body gửi SMS

{
    "sms": {
        "service_id": "12",
        "content": "nội dung tin nhắn",
        "phone": "0980000000"
    }
}

Mẫu curl gửi tin nhắn SMS

curl --location --globoff 'https://api.caresoft.vn/{{domain}}/api/v1/sms' \
--header 'Authorization: Bearer {{apiToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "sms": {
        "service_id": "12",
        "content": "Chúc mừng sinh nhật quý khách hàng.",
        "phone": "0980000000"
    }
}'

Mẫu POSTMAN cấu hình thông tin gửi SMS

Gửi tin nhắn SMS

POST {{domain}}/api/v1/sms

API gửi SMS

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

Request Body

Name	Type	Description
sms*	Object	Theo Thông tin trường dữ liệu SMS

200: OK

Kết quả điển hình

{
  "code": "ok",
  "ticket": {
    "ticket_id": 291437,
    "ticket_no": 205025,
    "requester_id": 63203810,
    "assignee_id": 1
  }
}

Mô tả kết quả

STT	Tên trường	Kiểu	Ý nghĩa
1	code	String	Trạng thái thành công
2	ticket	Object	Đối tượng phiếu ghi được tạo mới/Hoặc cập nhật khi gửi SMS

400: Bad Request

500: Internal Server Error