alfa vārdu pieprasījums
API maršruti, lai izveidotu un uzskaitītu alfa nosaukumus (pārbaudīti uzņēmumu nosaukumi, kas tiek izmantoti kā ziņojuma sūtītājs).
1. Izveidojiet organizācijas alfa nosaukumu
Šis POST pieprasījums tiek izmantots, lai izveidotu jaunu alfa nosaukumu, kas saistīts ar organizāciju. Pieprasījuma galvenēs ir jāievada organizācijas autorizācijas atslēga.
Pieprasījums
- URL: https://restapi.smsbat.com/organizations/alpha_name
- Metode: POSTĪT
- Galvenes:
- "Pieņemt: lietojumprogramma/json".
- X-Authorization-Key: {organization_token} (Izveidots sadaļā Lietotāja profils).
Korpuss:
Korpusa parametri: 1. nosaukums (virkne): ierosinātais alfa nosaukums. - Prasība: garumam ir jābūt mazākam par 12 rakstzīmēm. 2. CompanyCode (virkne): uzņēmuma reģistrācijas kods, kas saistīts ar alfabētu (ERPOU/IPN Ukrainai).
Iespējamās atbildes: - 200 Labi: Alfa nosaukums tika veiksmīgi nosūtīts moderēšanai/izveidei. - 400 Slikts pieprasījums: Validācijas kļūda (piemēram, nosaukums ir pārāk garš). - 401 Neautorizēts: nederīgs vai trūkst X-Authorization-Key.
2. Ielādēt alfabēta nosaukumu sarakstu
Izgūst jaunāko alfa vārdu sarakstu, tostarp to pašreizējos moderēšanas statusus.
Pieprasījums
- URL: https://restapi.smsbat.com/organizations/alpha_name/list
- Metode: IEGŪT
- Galvenes:
- X autorizācijas atslēga: {organization_token}
Atbilde (200 OK):
[
{
"name": "test1",
"status": "Pending Approval",
"statusCode": "PA",
"statusUpdateDate": "2024-07-24T16:34:40.137432Z"
},
{
"name": "test2",
"status": "Approved",
"statusCode": "A",
"statusUpdateDate": "2024-07-24T15:46:50.494443Z"
}
]
Alfa nosaukuma statusi (statusCode):
— PA — gaida apstiprinājumu
- "A" - apstiprināts
- D - Atteicās