Tài liệu dịch vụ do INCOM cung cấp.
\nMọi thắc mắc vui lòng liên hệ trực tiếp với nhân viên kinh doanh hoặc kỹ thuật để được hỗ trợ sớm nhất.
\nMô hình kết nối mẫu:
\nAPI dùng để gửi tin OMNI đến số điện thoại
\nusername và password : tài khoản và mật khẩu do INCOM cung cấp
\nphonenumber : số điện thoại nhận tin (Khuyến cáo dạng chuẩn 84)
\nrequestId: Mã định danh do đối tác quy định (0-40 ký tự)
\nrouterule : Rule các kênh sẽ đi theo cơ chế trượt kênh thông minh (kênh đầu tiên nếu gửi thất bại sẽ tự động chuyển kênh thứ 2 gửi, nếu thất bại, tiếp tục chuyển kênh thứ 3). 1: ZNS , 2: Autocall, 3: SMS
\ntemplatecode : mã template của phía INCOM cấp khi đăng ký template
\nlist_param : danh sách các biến (tùy thuộc vào template sẽ có danh sách biến khác nhau
\nAPI dùng để chủ động lấy trạng thái của tin OMNI theo idOmniMess nhận được khi tạo request Send Message OMNI thành công
\nAPI dùng để lấy danh sách template được cấp quyền theo account api đã cấp
\nusername và password : tài khoản và mật khẩu do INCOM cung cấp
\ntemplateCode: tên template cần tìm kiếm
\nitemcount: số template muốn lấy.
\npage: phân trang muốn lấy.
\nAPI dùng để cập nhật lại link nhận webhook tài khoản api omni
\nusername và password : tài khoản và mật khẩu do INCOM cung cấp
\nEndpoint: đường dẫn link webhook trả dữ liệu.
\nHeader: Header đường dẫn
\nAPI Lấy kết quả Template Rating của Zalo
\nAPI để lấy access_token dùng cho xác thực khi gọi các API
\nAPI để lấy access_token dùng cho xác thực khi gọi các API
\nAPI dùng để gửi tin OMNI đến số điện thoại
\nphonenumber : số điện thoại nhận tin (Khuyến cáo dạng chuẩn 84)
\nrouterule : Rule các kênh sẽ đi theo cơ chế trượt kênh thông minh (kênh đầu tiên nếu gửi thất bại sẽ tự động chuyển kênh thứ 2 gửi, nếu thất bại, tiếp tục chuyển kênh thứ 3). 1: ZNS , 2: Autocall, 3: SMS
\nrequestId: Mã định danh do đối tác quy định (0-40 ký tự)
\ntemplatecode : mã template của phía INCOM cấp khi đăng ký template
\nlist_param : danh sách các biến (tùy thuộc vào template sẽ có danh sách biến khác nhau
\nAPI dùng để chủ động lấy trạng thái của tin OMNI theo idOmniMess nhận được khi tạo request Send Message OMNI thành công
\nAPI dùng để lấy danh sách template được cấp quyền theo account api đã cấp
\nitemcount: số template muốn lấy.
\npage: phân trang muốn lấy.
\ntemplateCode: tên template cần tìm kiếm
\nAPI dùng để cập nhật lại link nhận webhook tài khoản api omni
\nAPI Lấy kết quả Template Rating của Zalo
\nItemCount: số template muốn lấy.
\nPage: phân trang muốn lấy.
\nFrom: ngày bắt đầu.
\nTo: ngày kết thúc.
\nTemplateCode: templateCode rating Incom cung cấp.
\nINCOM sẽ trả trạng thái tin thông qua request HTTP POST với các thông tin như sau:
\nHeader: ICOMNI-Signature: <đoạn mã do 2 bên quy định>
\n Body:\n\n{
\"idOmniMess\":Chuỗi tiền tố ICOMNI và 30 ký tự,
\"Status\":\"trạng thái tin\",
\"requestId\":\"requestid đối tác truyền sang lúc gửi tin\",
\"Channel\":\"string\",
\"ErrorCode\":\"string\"
}
Note:
\n- Dữ liệu trả về theo từng kênh:
\nZNS:
{
\"IdOmniMess\": \"ICOMNI-XXXXXXXXXXX\",
\"Status\": \"SUCCESS\" ,
\"requestId\":\"AAAAAAAAAA\",
\"Channel\":\"ZNS\"
\"ErrorCode\":\"0\"
}
Trong đó Status trả về trạng thái:
\"SUCCESS\": Tin đã được đến zalo thành công
\"RECEIVE\": Người dùng đã nhận được tin nhắn zalo
\"FAIL\": Thất bại
Auto Call :
{
\"IdOmniMess\": \"ICOMNI-XXXXXXXXXXX\",
\"Status\": \"SUCCESS\" ,
\"requestId\":\"AAAAAAAAAA\",
\"Channel\":\"AUTOCALL\",
\"ErrorCode\":\"0\"
}
Trong đó Status trả về trạng thái:
\"PROCESSING\": Tin đang xử lý
\"SUCCESS\": Tin gửi đến máy thành công
\"FAIL\": Thất bại
Brandname SMS:
{
\"IdOmniMess\": \"ICOMNI-XXXXXXXXXXX\",
\"Status\": \"SUCCESS\" ,
\"requestId\":\"AAAAAAAAAA\",
\"Channel\":\"BRANDNAMESMS\",
\"ErrorCode\":\"0\",
\"MtCount\" 1,
\"TelcoId\" : 1
}
Trong đó:
MtCount: số lượng tin tính tiền,
TelcoId: Id của nhà mạng
Status trả về trạng thái:
\"SUCCESS\": Tin gửi đến máy thành công
\"FAIL\": Thất bại
-Khi status là FAIL sẽ có thêm ErrorCode (mã lỗi) tùy thuộc vào các kênh khác nhau sẽ có mã lỗi khác nhau chi tiết tại link: https://docs.google.com/spreadsheets/d/10hfSIx-fFJ6zGzlSdZGKqW5g7VEyzK2iNzjBkTwtZCg
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3a177b42-2b23-444a-91a3-ddcba9326a35"}],"id":"b2ac3bec-665c-4c04-b74b-1ebcd121511d","description":"API gửi tin đa kênh (OMNI)
\n","_postman_id":"b2ac3bec-665c-4c04-b74b-1ebcd121511d"},{"name":"OMNI ver EN","item":[{"name":"Basic Auth","item":[{"name":"Send Message OMNI","id":"1db4c704-0e3b-41c9-a57b-7e7abd9d4933","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"XXXXXXXXXX\",\r\n \"password\":\"XXXXXXXXXX\",\r\n \"phonenumber\":\"XXXXXXXXXX\",\r\n \"routerule\":[\r\n \"1\",\"2\",\"3\"\r\n ],\r\n \"templatecode\":\"XXXXXXX\",\r\n \"list_param\":{\r\n \"XXXX\":\"XXXXX\",\r\n \"YYYY\":\"YYYYY\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://omni.incom.vn/api/OmniMessage/SendMessage","description":"API used to send OMNI messages to phonenumbers
\nThis API use for get message status OMNI base on idOmniMess which was recieved when create request Send Message OMNI success.
\nThis API use to get list template was mapping with the account
\nAPI used to update the webhook URL for the Omni API account.
\nUsername and password: Provided by INCOM.
\nEndpoint: The URL for receiving webhook data.
\nHeader: The header containing the URL.
\nStartFragment
\nAPI to Get Zalo Template Rating Results
Request:
API to obtain an access_token for authentication when calling APIs.
\nAPI to obtain an access_token for authentication when calling APIs.
\nAPI used to send OMNI messages to a phone number.
\nphonenumber: Recipient's phone number (recommended in standard 84 format).
\nrouterule: Rule for channel routing using an intelligent fallback mechanism (if the first channel fails, it automatically switches to the second, and if that fails, it switches to the third). 1: ZNS, 2: Autocall, 3: SMS.
\ntemplatecode: Template code provided by INCOM upon template registration.
\nlist_param: List of variables (varies depending on the template).
\nAPI used to proactively retrieve the status of an OMNI message based on the idOmniMess received when successfully creating a Send Message OMNI request.
\nAPI used to retrieve the list of templates authorized for the given API account
\nitemcount is the number of templates to retrieve
\npage is the page number to retrieve
\ntemplateCode is the name of the template to search for.
\nAPI used to update the webhook URL for the Omni API account
\nEndpoint is the URL for receiving webhook data
\nHeader is the header containing the URL
\nAPI Lấy kết quả Template Rating của Zalo
\nItemCount: số template muốn lấy.
\nPage: phân trang muốn lấy.
\nFrom: ngày bắt đầu.
\nTo: ngày kết thúc.
\nTemplateCode: templateCode rating Incom cung cấp.
\nINCOM will send message status with HTTP POST:
\nHeader: ICOMNI-Signature:
\n Body:\n\n{
\"idOmniMess\":\"ICOMNI-XXXXXXXXXXXXXXXXXX\",
\"Status\":\"string\",
\"Channel\":\"string\",
\"ErrorCode\":\"string\"
}
Note:
\n- Status:
\n-ErrorCode: More detail at link: https://docs.google.com/spreadsheets/d/10hfSIx-fFJ6zGzlSdZGKqW5g7VEyzK2iNzjBkTwtZCg
\n-With separate channels, there will be additional fields of necessary information:
\nAPI OMNI Document
\n","_postman_id":"1983007b-9bf1-4430-a3b9-d49e7fbacbcc"},{"name":"OMNI SandBox","item":[{"name":"Basic Auth","item":[{"name":"Send Message OMNI","id":"d24348cb-deba-4884-a960-96ebee52ff1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"*******\",\r\n \"password\":\"*******\",\r\n \"phonenumber\":\"0345215309\",\r\n \"routerule\":[\r\n \"1\",\"2\",\"3\"\r\n ],\r\n \"templatecode\":\"OTPTEST\",\r\n \"list_param\":{\r\n \"otp\":\"XXXXX\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://pocsite.incom.vn/api/OmniMessage/SendMessage","description":"API dùng để gửi tin OMNI đến số điện thoại
\nAPI dùng để chủ động lấy trạng thái của tin OMNI theo idOmniMess nhận được khi tạo request Send Message OMNI thành công
\nAPI dùng để lấy danh sách template được cấp quyền theo account api đã cấp
\nusername và password : tài khoản và mật khẩu do INCOM cung cấp
\ntemplateCode: tên template cần tìm kiếm
\nitemcount: số template muốn lấy.
\npage: phân trang muốn lấy.
\nAPI Lấy kết quả Template Rating của Zalo
\nAPI dùng để cập nhật lại link nhận webhook tài khoản api omni
\nusername và password : tài khoản và mật khẩu do INCOM cung cấp
\nEndpoint: đường dẫn link webhook trả dữ liệu.
\nHeader: Header đường dẫn
\nAPI để lấy access_token dùng cho xác thực khi gọi các API
\nAPI dùng để chủ động lấy trạng thái của tin OMNI theo idOmniMess nhận được khi tạo request Send Message OMNI thành công
\nAPI dùng để gửi tin OMNI đến số điện thoại
\nAPI dùng để lấy danh sách template được cấp quyền theo account api đã cấp
\ntemplateCode: tên template cần tìm kiếm
\nitemcount: số template muốn lấy.
\npage: phân trang muốn lấy.
\nAPI Lấy kết quả Template Rating của Zalo
\nItemCount: số template muốn lấy.
\nPage: phân trang muốn lấy.
\nFrom: ngày bắt đầu.
\nTo: ngày kết thúc.
\nTemplateCode: templateCode rating Incom cung cấp.
\nAPI dùng để cập nhật lại link nhận webhook tài khoản api omni
\nEndpoint: đường dẫn link webhook trả dữ liệu.
\nHeader: Header đường dẫn
\nINCOM sẽ trả trạng thái tin thông qua request HTTP POST với các thông tin như sau:
\nHeader: ICOMNI-Signature: <đoạn mã do 2 bên quy định>
\n Body:\n\n{
\"idOmniMess\":Chuỗi tiền tố ICOMNI và 30 ký tự,
\"Status\":\"trạng thái tin\",
\"Channel\":\"string\",
\"ErrorCode\":\"string\"
}
Note:
\n- Dữ liệu trả về theo từng kênh:
\nZNS:
{
\"IdOmniMess\": \"ICOMNI-XXXXXXXXXXX\",
\"Status\": \"SUCCESS\" ,
\"Channel\":\"ZNS\"
\"ErrorCode\":\"0\"
}
Trong đó Status trả về trạng thái:
\"SUCCESS\": Tin đã được đến zalo thành công
\"RECEIVE\": Người dùng đã nhận được tin nhắn zalo
\"FAIL\": Thất bại
Auto Call :
{
\"IdOmniMess\": \"ICOMNI-XXXXXXXXXXX\",
\"Status\": \"SUCCESS\" ,
\"Channel\":\"AUTOCALL\",
\"ErrorCode\":\"0\"
}
Trong đó Status trả về trạng thái:
\"PROCESSING\": Tin đang xử lý
\"SUCCESS\": Tin gửi đến máy thành công
\"FAIL\": Thất bại
Brandname SMS:
{
\"IdOmniMess\": \"ICOMNI-XXXXXXXXXXX\",
\"Status\": \"SUCCESS\" ,
\"Channel\":\"BRANDNAMESMS\",
\"ErrorCode\":\"0\",
\"MtCount\" 1,
\"TelcoId\" : 1
}
Trong đó:
MtCount: số lượng tin tính tiền,
TelcoId: Id của nhà mạng
Status trả về trạng thái:
\"SUCCESS\": Tin gửi đến máy thành công
\"FAIL\": Thất bại
-Khi status là FAIL sẽ có thêm ErrorCode (mã lỗi) tùy thuộc vào các kênh khác nhau sẽ có mã lỗi khác nhau chi tiết tại link: https://docs.google.com/spreadsheets/d/10hfSIx-fFJ6zGzlSdZGKqW5g7VEyzK2iNzjBkTwtZCg
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"003aca84-9850-4b12-960f-e6de9f6fc420"}],"id":"83870522-3d7e-4447-bd4a-1588101ffee3","description":"API gửi tin đa kênh (OMNI)
\n","_postman_id":"83870522-3d7e-4447-bd4a-1588101ffee3"},{"name":"ZNS Follower","item":[{"name":"Send Message Follower","id":"c39fea59-936f-461d-9db8-5e77da0e4059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"XXXXXXXXX\",\r\n \"password\":\"XXXXXXXXX\",\r\n \"oaname\":\"INCOM\",\r\n \"request\":{\r\n \"recipient\":{\r\n \"user_id\":\"1234567890\"\r\n },\r\n \"message\":{\r\n \"text\":\"hello, world!\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://zns.incom.vn/api/ZNS/MessageFollower","description":"API dùng để gửi tin nhắn từ OA đến 1 userid đã follower OA. INCOM sẽ xác thực và forward request của partner tới Zalo:
\nAPI dùng để lấy danh sách ID User Follower theo OA
\nTham khảo: Tài liệu Zalo
\n","urlObject":{"protocol":"https","path":["api","ZNS","GetFollower"],"host":["zns","incom","vn"],"query":[],"variable":[]}},"response":[],"_postman_id":"1377d428-dee7-46f0-ba9e-25db2475889a"}],"id":"3c9467a1-6b1e-4b41-9338-484669e95d49","description":"API gửi tin đến user ID follower OA
\n","_postman_id":"3c9467a1-6b1e-4b41-9338-484669e95d49"},{"name":"SMS QC","item":[{"name":"Send Campaign QC","id":"e477b3eb-9240-4bb2-9692-768b6b99afb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Username\":\"xxxxx\",\r\n \"Password\":\"xxxxxxxxx\",\r\n \"ListTo\":[\r\n \"84343775677\",\r\n \"84789834958\"\r\n],\r\n \"Brandname\":\"INCOM\",\r\n \"MessageContent\":\"incom test qc.\",\r\n \"Schedule\":\"2022/02/16 15:00:00\",\r\n \"RequestId\":\"TEST1502_002\",\r\n \"ListTelcoFilter\":[\r\n 1,2,3,11,12\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://ics.incom.vn/api/ApiForCampaign/SendCampaignQCAPI","description":"API gửi đơn hàng SMS QC
\nUsername và Password : do INCOM cung cấp
\nListTo: danh sách số điện thoại nhận tin (khuyến cáo dạng chuẫn 84)
\nBrandname: tên thương hiệu dùng để gửi tin đến số điện thoại
\nMessageContent: nội dung muốn gửi
\nSchedule: thời gian hẹn gửi
\nRequestId: mã đơn hàng (không bắt buộc)
\nListTelcoFilter: danh sách telco id muốn gửi (Mobi:1; Vina:2; Viettel:3; Gtel:11; VNM: 12)
\nAPI lấy report campaign QC
\nUsername và Password : do INCOM cung cấp
\nRequestId: mã đơn hàng KH truyền vào khi sử dụng api Send Campaign QC
\nCampaignId : mã đơn hàng hệ thống INCOM trả về khi sử dụng api Send Campaign QC
\nAPI gửi OTP thông qua kênh thoại
\n- username và password sẽ được INCOM cấp. Liên hệ với kinh doanh và kỹ thuật để biết rõ hơn.
\n- otp : Mã OTP từ 4 đến 8 ký (cho phép cả ký tự chữ & số)
\n- phonenumber: số nhận OTP (Khuyến cáo dạng chuẩn 84)
\n- codescript: mã kịch bản đọc OTP được bên INCOM cấp
\n","urlObject":{"protocol":"https","path":["api","VoiceOTP","SendOTP"],"host":["autocall","incom","vn"],"query":[],"variable":[]}},"response":[],"_postman_id":"f122060e-6bba-4d16-abf4-e17850e0b401"},{"name":"Get Status Voice","id":"bf94fd20-e8fe-4601-9d55-b23a97d6acc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"\",\r\n \"password\":\"\",\r\n \"idVoice\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://autocall.incom.vn/api/VoiceOTPReport/GetStatus","description":"API dùng để lấy trạng thái cuộc gọi chủ động
\n- username và password sẽ được INCOM cấp. Liên hệ với kinh doanh và kỹ thuật để biết rõ hơn.
\n- idVoice: IdVoice nhận dc khi call api Send VoiceOTP
\nEndFragment
\n","urlObject":{"protocol":"https","path":["api","VoiceOTPReport","GetStatus"],"host":["autocall","incom","vn"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf94fd20-e8fe-4601-9d55-b23a97d6acc3"},{"name":"Webhook","id":"fca0dbc7-824a-42e1-8f34-cd7f43115428","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"caller\":\"\",\r\n \"duration\":\"\",\r\n \"timecall\":\"\",\r\n \"status\":\"\",\r\n \"voiceid\":\"\",\r\n \"phonenum\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"Hệ thống INCOM sẽ thực hiện callback theo url bên khách hàng đã cung cấp theo format bên dưới.
\n+ Fail : thực hiện cuộc gọi thất bại
\n+ Answered : đã nhận được trả lời (tính phí có thể dựa vào duration)
\n+ Busy : người dùng bận hoặc từ chối cuộc gọi.
\n+ No Answered : người dùng k bắt máy
\nBộ API dùng để kết nối dịch vụ gửi OTP đến khách hàng thông qua kênh thoại
\n","_postman_id":"eaa9e0ca-8963-4728-8f4b-445d1e7a3d84"}]}