مستندات سرویس API پیامک
sms API Documents
نسخه 1.1.0 - 11/01/2024
فهرست مطالب
۱. مقدمه
در سرویس پیامک یوآیدی، با ارسال تلفن همراه کاربر و پیام ، ارسال پیام انجام میشود.
۲.فراخوانی سرویس api/sms/
برای استفاده از سرویس API یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت تلفن همراه کاربر و پیام ، پیام مور نظر به یوزر ارسال و در پاسخ،نتیجه ارسال پیامک و message که در صورت بروز خطا نوع آن را نشان می‌دهد.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/sms
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"mobileNumber" : "09000000000",
"message" : "your code is: 12334"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| mobileNumber | string | Required | تلفن همراه کاربر به صورت 09xxxxxxxxx |
| message | string | Required | پیام OTP |
۳. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "تایید شد",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"receipt": {
"messageId": "1234567890",
"message": "your code is: 12334",
"status": "RECEIPT_STATUS_SEND",
"statusText": "statusText",
"sender": "sender",
"receptor": "receptor",
"date": "date",
"cost": "0"
}
}
۱.۳. توضیح پارامترهای پاسخ
| Field | Type | Description |
code | int | کد پاسخ |
message | string | پیام ارسال OTP |
messageId | string | کد مسیج(جهت پیگیری پیام) |
message | string | پیامی که به یوزر رسیده |
status | string | وضعیت پیامک |
statusText | string | آخرین مرحله که پیام به آن ارسال شده |
sender | string | سرشماره ای که پیام را ارسال کرده |
receptor | string | شماره یوزر که پیام به شماره ارسال شده |
date | string | زمان ارسال این پیامک به فرمت UnixTime |
۲.۳. توضیح code
| Field | Value | Description |
code | 0 | پیام با موفقیت ارسال شد |
| code | 2 | خطای غیر منتظره |
| code | 3 | businessId یا businessToken اشتباه است |
| code | 14 | mobileNumber یا message اشتباه است |
