{"info":{"_postman_id":"ae97e64c-4319-43c2-b0d8-2fe4bf5466e9","name":"Uwazii RestAPI","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"17662889","collectionId":"ae97e64c-4319-43c2-b0d8-2fe4bf5466e9","publishedId":"UVC2HV2R","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"021131","highlight":"8A9E13"},"publishDate":"2021-11-05T10:38:41.000Z"},"item":[{"name":"Autorization","id":"0eac1585-c417-4931-b574-09cc1e63961e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"username\":\"UwaziiLogin\",\r\n \"password\":\"pass\"\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/authorize","description":"

Autorization via login and pass

\n","urlObject":{"protocol":"https","path":["v1","authorize"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0eac1585-c417-4931-b574-09cc1e63961e"},{"name":"Access token","id":"caff48d4-bc7c-4738-8d87-bcd65585cf7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"authorization_code\": \"b2cdedb10785e36928727a1ffb73aa4e\"\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/accesstoken","description":"

Ask access token via Authorization code (which we got from Autorization API)

\n","urlObject":{"protocol":"https","path":["v1","accesstoken"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"caff48d4-bc7c-4738-8d87-bcd65585cf7f"},{"name":"Me","id":"f3e28c22-ef5a-48bd-85ab-4e5bfeaa9abd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"di5B9xXcZeULyNAFSsdv9COWOzBPWD","description":"

Token to auth

\n"}],"url":"https://restapi.uwaziimobile.com/v1/me","description":"

Asking information about account via Token (which we got from Access token API)

\n","urlObject":{"protocol":"https","path":["v1","me"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3e28c22-ef5a-48bd-85ab-4e5bfeaa9abd"},{"name":"Send single sms","id":"59379aa6-81df-4131-b5d6-959c46bb8dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"efe36eb9de336ef133f0cb837a6afed7","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\r\n \"number\":[\"254722157527\"],\r\n \"senderID\":\"Uwazii\",\r\n \"text\":\"Hello\\nHowdfdfsdfdgdsf авапавпвап авп ваыпывапыв аывап ывап ывапывапвапвыапывапывапп вапвапвапвапав are you?\",\r\n \"type\":\"sms\",\r\n \"beginDate\":\"2018-12-31\",\r\n \"beginTime\":\"11:00\",\r\n \"lifetime\":555,\r\n \"delivery\":false\r\n},\r\n{\r\n \"number\":[\"380662225582\",\"79225558877\"],\r\n \"senderID\":\"Uwazii\",\r\n \"text\":\"Hello\\nHow are you?\",\r\n \"type\":\"sms\",\r\n \"beginDate\":\"2018-12-31\",\r\n \"beginTime\":\"11:00\",\r\n \"lifetime\":555,\r\n \"delivery\":false\r\n}]"},"url":"https://restapi.uwaziimobile.com/v1/send","description":"

Send SMS using access token.\nBy params:

number - list of the phone numbers
senderID - sender ID from which your sms will fgo
text - content of the message
type - type of message (SMS, HLR, WAPPUSH, FLASHSMS)
beginDate - plan date where message will go
beginTime - plan time where message will go
lifetime - period how long message will live
delivery - enbale of authomatical back of DLR reports

WARNING: Not more then 200 messages by one package

\n","urlObject":{"protocol":"https","path":["v1","send"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"59379aa6-81df-4131-b5d6-959c46bb8dd5"},{"name":"Group list","id":"2f2ff8fb-2647-48ec-ac9f-e89d6c312149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"id_group\":12,\r\n\t\"limit\":5,\r\n\t\"offset\":1\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/group","description":"

Group list of user's account\nFields:

id_group - group ID
limit - limit of list data (not more 100)
offset - pages of list

\n","urlObject":{"protocol":"https","path":["v1","group"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f2ff8fb-2647-48ec-ac9f-e89d6c312149"},{"name":"Create group","id":"f0731f0a-4a36-4b4a-8ffd-713ee58bf61e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name_group\": \"bigRest\",\r\n \"time_birth\": \"23:22\",\r\n \"originator_birth\": \"aadfd\",\r\n \"text_birth\": \"ss#middssasale_name#s\",\r\n \"on_birth\": false\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/group-create","description":"

Creating group of numbers for bulk sending\nFields:

name_group - name of the group
time_birth - congratulations time
originator_birth - SenderID for sms of congratulations
text_birth - text of congratulations
on_birth - mark of enabling congratulations

\n","urlObject":{"protocol":"https","path":["v1","group-create"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0731f0a-4a36-4b4a-8ffd-713ee58bf61e"},{"name":"Delete group","id":"2393489b-971e-4475-990b-fe7986d4c5de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id_group\": [1,2,3,4,5,6,7,8,9,10,11,12]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/group-delete","description":"

Deleting groups of numbers of user\nFields:

id_group - a list of groups for deleting

\n","urlObject":{"protocol":"https","path":["v1","group-delete"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2393489b-971e-4475-990b-fe7986d4c5de"},{"name":"Add numbers in group","id":"3fbd5a2b-5a87-46e3-b781-c8bf2f1c9b36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id_group\": 13,\r\n \"numbers\":[{\r\n \"number\":254722157527,\r\n \"name\":\"Iogan\",\r\n \"surname\":\"Bah\",\r\n \"patronymic\":\"Sebastian\",\r\n \"date_birth\":\"2018-12-31\",\r\n \"male\":\"m\",\r\n \"addition_1\":\"tralivali\",\r\n \"addition_2\":\"tralivali2\"\r\n},\r\n{\r\n \"number\":254722157528,\r\n \"name\":\"Iogan2\",\r\n \"surname\":\"Bah2\",\r\n \"patronymic\":\"Sebastian2\",\r\n \"date_birth\":\"2018-12-31\",\r\n \"male\":\"l\",\r\n \"addition_1\":\"tralivali2\",\r\n \"addition_2\":\"tralivali23\"\r\n},\r\n{\r\n \"number\":254722157527,\r\n \"name\":\"Vasua\",\r\n \"surname\":\"asdas\",\r\n \"patronymic\":\"stroke\",\r\n \"date_birth\":\"2018-12-30\",\r\n \"male\":\"m\",\r\n \"addition_1\":\"wwww\",\r\n \"addition_2\":\"wwdqwqw\"\r\n},\r\n{\r\n \"number\":380660277249,\r\n \"name\":\"Vasua\",\r\n \"surname\":\"asdas\",\r\n \"patronymic\":\"stroke\",\r\n \"date_birth\":\"2018-12-30\",\r\n \"male\":\"m\",\r\n \"addition_1\":\"wwww\",\r\n \"addition_2\":\"wwdqwqw\"\r\n},\r\n{\r\n \"number\":380660977229,\r\n \"name\":\"Vasua\",\r\n \"surname\":\"asdas\",\r\n \"patronymic\":\"stroke\",\r\n \"date_birth\":\"2018-12-30\",\r\n \"male\":\"m\",\r\n \"addition_1\":\"wwww\",\r\n \"addition_2\":\"wwdqwqw\"\r\n}]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/group-number-add","description":"

Adding mobile numbers in group for bulk sending.\nAll numbers should be in international format\nFields:

id_group - group ID where we should add numbers
numbers - array of data
number - mobile number
name - name of mobile holder (not required)
surname - surname of mobile holder (not required)
patronymic - patronymic of mobile holder (not required)
date_birth - birthday of mobile holder (not required)
male - male of mobile holder (not required)
addition_1 - addinital info (not required)
addition_2 - addinital info (not required)

\n","urlObject":{"protocol":"https","path":["v1","group-number-add"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fbd5a2b-5a87-46e3-b781-c8bf2f1c9b36"},{"name":"Search numbers in group","id":"e805006f-11b9-4656-a61c-e9939491ffde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id_group\": 13,\r\n \"numbers\":[254722157527,254722157528,254722157527,380660277249,380660977229,17133010164]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/group-number-search","description":"

Looking for numbers in selected group\nFields:

id_group - group id
numbers - list of mobile numbers for search

\n","urlObject":{"protocol":"https","path":["v1","group-number-search"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e805006f-11b9-4656-a61c-e9939491ffde"},{"name":"Delete numbers from group","id":"3d1aedcd-fc72-4aad-ada1-039134ac7a35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id_group\": 13,\r\n \"numbers\":[254722157527,254722157528,380665558877,17133010164,15742201221]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/group-number-delete","description":"

Delete a list on numbers from selected group\nFields:

id_group - group ID
numbers - list of numbers for deleting

\n","urlObject":{"protocol":"https","path":["v1","group-number-delete"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d1aedcd-fc72-4aad-ada1-039134ac7a35"},{"name":"Bulk sending sms","id":"eda2dfd7-fa62-4a34-ba2e-ed9a1226e0ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"senderID\":\"Uwazii\",\r\n \"text\":\"Hello #first_name#, We send sms to #number#\",\r\n \"dateStart\":\"2019-12-14\",\r\n \"timeStart\":\"22:30\",\r\n \"timeStop\":\"22:30\",\r\n \"phone\":\"254722157527\",\r\n \"id_group\":[17],\r\n \"id_group_excluded\":[24,26]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/send-bulk","description":"

Send bulk sms from selected groups\nFields:

senderID - sender name of sms
text - content of sms
dateStart - date of begin of sending (not required)
timeStart - time of start sending (not required)
timeStop - time of stop sending (not required)
phone - extra number for sending (not required)
id_group - list of groups for sending
id_group_excluded - list of groups which numbers should not receive sms (not required)

\n","urlObject":{"protocol":"https","path":["v1","send-bulk"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eda2dfd7-fa62-4a34-ba2e-ed9a1226e0ad"},{"name":"Add numbers in black list","id":"bc671493-9034-415e-a663-9e9370cd2e01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"numbers\":[254722157527,254722157528,254722157527,254722157529]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/black-list-add","description":"

Add a list numbers at black list

\n","urlObject":{"protocol":"https","path":["v1","black-list-add"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc671493-9034-415e-a663-9e9370cd2e01"},{"name":"Search numbers at black list","id":"058ffa5b-afaa-4bd8-9c8f-0d9756924bce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

Looking for numbers in black list

\n","urlObject":{"protocol":"https","path":["v1","black-list-search"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"058ffa5b-afaa-4bd8-9c8f-0d9756924bce"},{"name":"Delete numbers from black list","id":"78b112f5-33a3-4c22-ab78-01ce50f0dac7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"87ee8c1b4119d737d2975d381c44a369","description":"

Token to auth

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"numbers\":[254722157528]\r\n}"},"url":"https://restapi.uwaziimobile.com/v1/black-list-delete","description":"

Deleting numbers from black list

\n","urlObject":{"protocol":"https","path":["v1","black-list-delete"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"78b112f5-33a3-4c22-ab78-01ce50f0dac7"},{"name":"Replacement","id":"545563b9-de7c-4a37-8787-827befc8864f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"di5B9xXcZeULyNAFSsdv9COWOzBPWD","description":"

Token to auth

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[{\n \"number\":[\"254722157529\", 254722157529],\n \"senderID\":\"Uwazii\",\n \"text\":\"Hello.\\How are you?\"\n}]"},"url":"https://restapi.uwaziimobile.com/v1/replacement","description":"

RestAPI for Content replacement rules

\n","urlObject":{"protocol":"https","path":["v1","replacement"],"host":["restapi","uwaziimobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"545563b9-de7c-4a37-8787-827befc8864f"}]}