Current Version: v1
\nVersion list:
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8259884","collectionId":"b9b009bb-ffde-4895-a26c-9cc3219adf6b","publishedId":"SVYjThTY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-07-26T08:19:48.000Z"},"item":[{"name":"Base Url","item":[],"id":"a6bbdf4f-9ed3-4612-bf11-6342bfcf89ac","description":"Base Url of multichannel qiscus chat. Fill the {{BaseUrl}} variable on env in postman or just write or replace the current base url to multichannel production url: https://multichannel.qiscus.com
\n","event":[{"listen":"prerequest","script":{"id":"8d3179ef-8f27-4de1-854b-0b0913e31cc9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"555d118e-da2c-44bf-a1a2-b1ad59a7e4c5","type":"text/javascript","exec":[""]}}],"_postman_id":"a6bbdf4f-9ed3-4612-bf11-6342bfcf89ac"},{"name":"Auth","item":[{"name":"Login Admin","event":[{"listen":"test","script":{"id":"e2d115f0-cf8d-4314-b259-8b9dca3ca502","exec":["var jsonData = JSON.parse(responseBody)","pm.environment.set(\"AdminToken\", jsonData.data.user.authentication_token);","pm.environment.set(\"AppCode\", jsonData.data.details.app.app_code);"],"type":"text/javascript"}}],"id":"ab412ede-02ec-4f55-ba0c-c6e3404e9c2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"{{AdminEmail}}","type":"text"},{"key":"password","value":"{{AdminPassword}}","type":"text"}]},"url":"{{BaseUrl}}/api/v1/auth","description":"An endpoint to authenticate admin access, you can save user.authentication_token to use the other qismo endpoints.
\nOn the otherside, you can also use details.sdk_user object to connect with qiscus sdk client. For example if you want to load all your ongoing conversations you should use Qiscus SDK loadConversations functionality, for more information to authenticate with qiscus-sdk, plase check our sdk documentation
\n{\n \"data\": {\n \"user\": {\n \"id\": 2,\n \"name\": \"Qismo\",\n \"email\": \"qiscus_69f45_qismo.demo@gmail.com\",\n \"authentication_token\": \"evusPVPaYYFE3DwKm4la\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2019-01-25 08:01:36\",\n \"sdk_email\": \"ziv-nqsjtf0zdqf6kfk7s_admin@qismo.com\",\n \"sdk_key\": \"d283c\",\n \"is_available\": true,\n \"type\": 1,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/jKvSjCP6Gr/customer-support.png\",\n \"app_id\": 2,\n \"is_verified\": true,\n \"notifications_room_id\": \"932825\",\n \"bubble_color\": \"#1CFF3F\",\n \"qismo_key\": \"9JtR8k\",\n \"type_as_string\": \"admin\",\n \"assigned_rules\": [],\n \"app\": {\n \"id\": 2,\n \"name\": null,\n \"app_code\": \"ziv-nqsjtf0zdqf6kfk7s\",\n \"secret_key\": \"fd36b23d5198ae3eaadd0f5b59163d32\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2018-12-04 02:08:31\",\n \"bot_webhook_url\": \"https://kanal.kata.ai/receive_message/0a5200c4-9d38-4f9e-b7b3-0f8ae2e68124\",\n \"is_bot_enabled\": true,\n \"allocate_agent_webhook_url\": null,\n \"is_allocate_agent_webhook_enabled\": false,\n \"mark_as_resolved_webhook_url\": \"https://telek.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": false,\n \"is_mobile_pn_enabled\": true,\n \"is_active\": true,\n \"agent_roles\": [\n {\n \"id\": 181,\n \"app_id\": 2,\n \"name\": \"General\",\n \"is_default_role\": true,\n \"created_at\": \"2018-08-29 14:02:12\",\n \"updated_at\": \"2018-08-29 14:02:12\"\n },\n {\n \"id\": 195,\n \"app_id\": 2,\n \"name\": \"Billing\",\n \"is_default_role\": false,\n \"created_at\": \"2018-08-29 14:37:45\",\n \"updated_at\": \"2018-08-29 14:37:45\"\n },\n {\n \"id\": 197,\n \"app_id\": 2,\n \"name\": \"Supervisor\",\n \"is_default_role\": false,\n \"created_at\": \"2018-08-30 10:13:53\",\n \"updated_at\": \"2018-08-30 10:13:53\"\n }\n ]\n }\n },\n \"details\": {\n \"is_integrated\": true,\n \"sdk_user\": {\n \"id\": 672539,\n \"token\": \"Iz9xetGy5wIj1O2Ao7Ly\",\n \"email\": \"ziv-nqsjtf0zdqf6kfk7s_admin@qismo.com\",\n \"password\": \"d283c\",\n \"display_name\": \"Qismo\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/jKvSjCP6Gr/customer-support.png\",\n \"last_comment_received_id\": 14137233\n },\n \"app\": {\n \"id\": 2,\n \"name\": null,\n \"app_code\": \"ziv-nqsjtf0zdqf6kfk7s\",\n \"secret_key\": \"fd36b23d5198ae3eaadd0f5b59163d32\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2018-12-04 02:08:31\",\n \"bot_webhook_url\": \"https://kanal.kata.ai/receive_message/0a5200c4-9d38-4f9e-b7b3-0f8ae2e68124\",\n \"is_bot_enabled\": true,\n \"allocate_agent_webhook_url\": null,\n \"is_allocate_agent_webhook_enabled\": false,\n \"mark_as_resolved_webhook_url\": \"https://telek.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": false,\n \"is_mobile_pn_enabled\": true,\n \"is_active\": true,\n \"agent_roles\": [\n {\n \"id\": 181,\n \"app_id\": 2,\n \"name\": \"General\",\n \"is_default_role\": true,\n \"created_at\": \"2018-08-29 14:02:12\",\n \"updated_at\": \"2018-08-29 14:02:12\"\n },\n {\n \"id\": 195,\n \"app_id\": 2,\n \"name\": \"Billing\",\n \"is_default_role\": false,\n \"created_at\": \"2018-08-29 14:37:45\",\n \"updated_at\": \"2018-08-29 14:37:45\"\n },\n {\n \"id\": 197,\n \"app_id\": 2,\n \"name\": \"Supervisor\",\n \"is_default_role\": false,\n \"created_at\": \"2018-08-30 10:13:53\",\n \"updated_at\": \"2018-08-30 10:13:53\"\n }\n ]\n }\n }\n }\n}\nAn endpoint To logging in agent, you can save user.authentication_token to use the other endpoints
\nOn the otherside, you can also use details.sdk_user object to connect with qiscus sdk client. for example if you want to load all your ongoing conversations, for more information to authenticate with qiscus-sdk, plase check our sdk documentation
\n","urlObject":{"path":["api","v1","{{AppCode}}","agent_auth"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0a4fe10-37d4-4af1-8460-9687b91d0619"},{"name":"Get Identity Token","id":"690e5c6c-4d3a-44bb-a227-73d08fc822ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{UserToken}}"}],"body":{"mode":"formdata","formdata":[{"key":"app_id","value":"{{AppId}}","type":"text"},{"key":"nonce","value":"","type":"text"},{"key":"email","value":"","type":"text"},{"key":"avatar_url","value":"","type":"text"}]},"url":"{{BaseUrl}}/api/v1/get_identity_token","description":"In case you want to securely logging in to access all your conversations you can use qiscus-sdk server jwt authentication. For the information please check our documentation
\n{\n \"data\": {\n \"identity_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInZlciI6InYyIn0.eyJpc3MiOiJ6aXYtbnFzanRmMHpkcWY2a2ZrN3MiLCJwcm4iOiJ6aXYtbnFzanRmMHpkcWY2a2ZrN3NfYWRtaW5AcWlzbW8uY29tIiwiaWF0IjoxNTQ4NDA3MzMzLCJuYmYiOjE1NDg0MDczMzMsImV4cCI6MTU0ODQwNzQ1MywibmNlIjoib2IxWTVBUE94MkJNVGVqYmVEZHNMN2xyNDd6S0VENmt2N0U5SnBueCIsIm5hbWUiOiJRaXNtbyIsImF2YXRhcl91cmwiOiIifQ.meLQ3rdqs4CaxFr9PxsY1L9_irUL9ahPHQd6k6KMlGA\",\n \"qismo_key\": \"BSWHgh\"\n }\n}\n\n{\n \"data\": {\n \"app_id\": 1,\n \"name\": \"review\",\n \"updated_at\": \"2019-03-06 08:02:15\",\n \"created_at\": \"2019-03-06 08:02:15\",\n \"id\": 1\n }\n}\nSample Response
\n{\n \"data\": [\n {\n \"id\": 1,\n \"app_id\": 1,\n \"name\": \"review\",\n \"created_at\": \"2019-03-06 08:02:15\",\n \"updated_at\": \"2019-03-06 08:02:15\"\n }\n ]\n}\n{\n \"data\": {\n \"room_log_id\": 46,\n \"tag_id\": 1,\n \"updated_at\": \"2019-03-06 08:21:38\",\n \"created_at\": \"2019-03-06 08:21:38\",\n \"id\": 2\n }\n}\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"review\"\n }\n ]\n}\n{\n \"data\": \"Data has been deleted\"\n}\n\nrequired
\n","type":"text"},{"key":"user_id","value":"","description":"required
\n","type":"text"},{"key":"name","value":"","description":"required
\n","type":"text"},{"key":"notes","value":"","description":"optional
\n","type":"text"},{"key":"user_properties","value":"","description":"optional | array, format sample [{'key': 'address', 'value': 'usa'}]
\n","type":"text"},{"key":"extras","value":"","description":"optional|json string
\n","type":"text"},{"key":"timezone_offset","value":"","description":"optional
\n","type":"text"},{"key":"allocate_agent","value":"","description":"optional|boolean, will allocate agent on initiate chat
\n","type":"text"},{"key":"room_badge","value":"","description":"optional|url
\n","type":"text"},{"key":"origin","value":"","description":"optional|url
\n","type":"text"},{"key":"reset_extras","value":"","description":"optional|boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/qiscus/initiate_chat","description":"Create new conversations for customer
\n{\n \"app_id\": \"oni-bgo2lummmhvzqxbt5\",\n \"user_id\": \"qiscustester@mail.com\",\n \"name\": \"Qiscus Tester\",\n \"user_properties\": [\n {\"key\":\"address\", \"value\": \"USA\"}\n ],\n \"notes\": \"this is note for user a\",\n \"extras\": \"{\\\"a\\\":\\\"b\\\"}\"\n}\n{\n \"data\": {\n \"identity_token\": null,\n \"room_id\": \"2066222\",\n \"sdk_user\": {\n \"id\": 33188426,\n \"token\": \"z2LdD50i1smrmrLwDqG4\",\n \"email\": \"buguru@gmail.com\",\n \"password\": \"buguru@gmail.com5Ms\",\n \"display_name\": \"buguru\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {\n \"additional_extras\": \"{\\\"dont-mind\\\":\\\"yes\\\"}\",\n \"is_customer\": true,\n \"type\": \"customer\"\n }\n },\n \"is_sessional\": null\n }\n}\n{\n \"data\": {\n \"extras\": {\n \"user_properties\": [\n {\n \"key\": \"Address\",\n \"value\": \"kuningan\"\n },\n {\n \"key\": \"Plan\",\n \"value\": \"Starter\"\n }\n ]\n },\n \"first_initiated\": \"2018-03-29T07:36:35+00:00\",\n \"first_agent_response_time\": \"2018-05-14T07:27:35+00:00\",\n \"user_id\": \"U1383c83f88b5c59019ea23eea93e0660\"\n }\n}\n\nrequired
\n","type":"text"},{"key":"room_avatar_url","value":"","type":"text"},{"key":"room_options","value":"","description":"json
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/update_room_info","description":"\nrequired, boolean
\n","type":"text"},{"key":"customer_name","value":"","description":"required
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/customer_profile/update","description":"\nAll about channels API (deprecated, plz move to v2)
\n","event":[{"listen":"prerequest","script":{"id":"60f37243-7430-46cc-8361-b8a32be43831","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f17e293d-7a64-4a61-8da4-25c923e3fd3a","type":"text/javascript","exec":[""]}}],"_postman_id":"0e310a4b-07d6-47d9-9d12-dcd755d1bf85"},{"name":"Agent Management","item":[{"name":"Roles","item":[{"name":"Create Roles","id":"2fd7be73-fbde-4f72-876f-bfdcda0dca53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","type":"text","value":""}]},"url":"{{BaseUrl}}/api/v1/admin/create_agent_role","description":"{\n \"data\": {\n \"app_id\": 19,\n \"name\": \"Accounting\",\n \"updated_at\": \"2018-08-14 02:12:59\",\n \"created_at\": \"2018-08-14 02:12:59\",\n \"id\": 12\n }\n}\n{\n \"data\": {\n \"app_id\": 19,\n \"name\": \"Accounting\",\n \"updated_at\": \"2018-08-14 02:12:59\",\n \"created_at\": \"2018-08-14 02:12:59\",\n \"id\": 12\n }\n}\n{\n \"data\": {\n \"app_id\": 19,\n \"name\": \"Accounting\",\n \"updated_at\": \"2018-08-14 02:12:59\",\n \"created_at\": \"2018-08-14 02:12:59\",\n \"id\": 12\n }\n}\n{\n \"data\": {\n \"agent_roles\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 11,\n \"app_id\": 19,\n \"name\": \"Accounting 2\",\n \"is_default_role\": true,\n \"created_at\": \"2018-08-14 07:02:49\",\n \"updated_at\": \"2018-08-14 07:02:49\"\n },\n {\n \"id\": 10,\n \"app_id\": 19,\n \"name\": \"General\",\n \"is_default_role\": false,\n \"created_at\": \"2018-08-14 05:16:31\",\n \"updated_at\": \"2018-08-14 05:16:31\"\n }\n ],\n \"first_page_url\": \"http://localhost:8000/api/v1/admin/agent_roles?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://localhost:8000/api/v1/admin/agent_roles?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://localhost:8000/api/v1/admin/agent_roles\",\n \"per_page\": 20,\n \"prev_page_url\": null,\n \"to\": 2,\n \"total\": 2\n },\n \"total\": 2,\n \"current_page\": 1\n }\n}\noptional
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"optional
\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"optional
\n","type":"text/plain"},"key":"page","value":null}],"variable":[]}},"response":[],"_postman_id":"0f9a272f-12fb-4a68-9c13-d8d976be495d"}],"id":"6effae9f-4687-4372-918a-6142aadca5ba","_postman_id":"6effae9f-4687-4372-918a-6142aadca5ba","description":""},{"name":"Create Agent","id":"00c73d23-e52a-4eea-b27d-ad7c04fa7c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"","type":"text"},{"key":"name","value":"","type":"text"},{"key":"password","value":"","type":"text"},{"key":"rules","value":"","description":"array | accepted values: ['fb_messaging', 'wa_messaging', 'line_messaging', 'qiscus_messaging']
\n","type":"text"},{"key":"agent_role_ids","value":"","description":"array | if null then it will fill with default agent role
\n","type":"text"},{"key":"is_supervisor","value":"","description":"optional|boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/create_agent","urlObject":{"path":["api","v1","admin","create_agent"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00c73d23-e52a-4eea-b27d-ad7c04fa7c40"},{"name":"Get or Create Agent","id":"bae3d944-2e36-42e4-a015-6b6ae55c76fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"sip@gmail.com","description":"required
\n","type":"text"},{"key":"name","value":"seep","description":"required if record not found
\n","type":"text"},{"key":"password","value":"password","description":"required if record not found
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/get_or_create_agent","description":"If record found it wont reject agent creation, instead it will show agent information that match the email. You probably need to depend on this this endpoint if you want to implement custom agent allocation
\n{\n \"data\": {\n \"id\": 484,\n \"name\": \"Sip Geeto\",\n \"email\": \"sip@gmail.com\",\n \"authentication_token\": \"wU5BGofTHVnnIbOhBuEd\",\n \"created_at\": \"2018-08-30 08:31:17\",\n \"updated_at\": \"2018-10-31 01:29:38\",\n \"sdk_email\": \"zJgwo_sip@gmail.com\",\n \"sdk_key\": \"8tMLV\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 2,\n \"is_verified\": false,\n \"notifications_room_id\": \"1104503\",\n \"bubble_color\": \"#2498b2\",\n \"qismo_key\": null,\n \"is_new_user\": false,\n \"type_as_string\": \"agent\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"line_messaging\",\n \"qiscus_messaging\",\n \"wa_messaging\",\n \"telegram_messaging\"\n ]\n }\n}\nGetting all agents info
\n{\n \"data\": {\n \"agents\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 554,\n \"name\": \"Delta Purna Widyangga\",\n \"email\": \"deltapurna@gmail.com\",\n \"authentication_token\": \"bFB3fIq2g2eWd1r9CMhh\",\n \"created_at\": \"2018-09-20 03:36:59\",\n \"updated_at\": \"2018-10-05 09:50:07\",\n \"sdk_email\": \"FMsVj_deltapurna@gmail.com\",\n \"sdk_key\": \"TTiQf\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 2,\n \"is_verified\": false,\n \"notifications_room_id\": \"1165403\",\n \"bubble_color\": \"#a2f720\",\n \"qismo_key\": null,\n \"latest_service\": {\n \"id\": 205005,\n \"user_id\": 554,\n \"room_log_id\": 171667,\n \"app_id\": 2,\n \"room_id\": \"1705318\",\n \"notes\": null,\n \"resolved_at\": null,\n \"is_resolved\": true,\n \"created_at\": \"2019-01-20 11:12:32\",\n \"updated_at\": \"2019-01-21 08:50:46\",\n \"first_comment_id\": \"13729533\",\n \"last_comment_id\": null,\n \"retrieved_at\": \"2019-01-20 11:12:32\",\n \"first_comment_timestamp\": \"2019-01-20 11:12:31\"\n },\n \"assigned_rules\": [\n \"qiscus_messaging\"\n ],\n \"current_customer_count\": 19,\n \"total_resolved\": 11,\n \"total_customers\": 30,\n \"assigned_agent_roles\": [\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ]\n }\n ],\n \"first_page_url\": \"http://qismo.qiscus.com/api/v1/admin/agents?page=1\",\n \"from\": 1,\n \"last_page\": 11,\n \"last_page_url\": \"http://qismo.qiscus.com/api/v1/admin/agents?page=11\",\n \"next_page_url\": \"http://qismo.qiscus.com/api/v1/admin/agents?page=2\",\n \"path\": \"http://qismo.qiscus.com/api/v1/admin/agents\",\n \"per_page\": \"1\",\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 11\n },\n \"total\": 11,\n \"current_page\": 1\n }\n}\noptional
\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"optional
\n","type":"text/plain"},"key":"limit","value":"2"}],"variable":[]}},"response":[],"_postman_id":"4c77514a-2977-4685-8501-5fcab14af030"},{"name":"Get Agent By IDs","id":"c2bf1554-a156-40eb-9512-2d919dd326af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"}],"url":"{{BaseUrl}}/api/v1/admin/agents/get_by_ids?ids[]=","description":"json { \"data\": [ { \"id\": 404, \"name\": \"Ganjar Widiatmansyah\", \"email\": \"g@mail.com\", \"authentication_token\": \"lmcAFeJIPvGkptztfFEq\", \"created_at\": \"2018-07-17 23:07:41\", \"updated_at\": \"2019-01-23 04:50:18\", \"sdk_email\": \"YXdiK_g@mail.com\", \"sdk_key\": \"xiXnt\", \"is_available\": true, \"type\": 2, \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\", \"app_id\": 2, \"is_verified\": false, \"notifications_room_id\": \"933195\", \"bubble_color\": \"#1f9846\", \"qismo_key\": \"4NUXIq\", \"current_customer_count\": 21, \"total_resolved\": 35, \"total_customers\": 56 } ] }
required|array
\n","type":"text/plain"},"key":"ids[]","value":""},{"disabled":true,"key":"Qiscus-App-Id","value":""}],"variable":[]}},"response":[],"_postman_id":"c2bf1554-a156-40eb-9512-2d919dd326af"},{"name":"Edit/Update Agent","id":"1eb7b707-87e3-4b11-96e8-ad7fbe015165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"{{AgentEmail}}","description":"required
\n","type":"text"},{"key":"name","value":"AgentName","description":"required
\n","type":"text"},{"key":"password","value":"","description":"optional | if this field not empty it will change password, reset qismo token and sdk token. For now if you entered qismo web you need to logout to reacquire your qismo access
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/agent/{{AgentId}}/update","description":"{\n \"data\": {\n \"id\": 404,\n \"name\": \"tusuk@gmail.com\",\n \"email\": \"bosok@gmail.com\",\n \"authentication_token\": \"lmcAFeJIPvGkptztfFEq\",\n \"created_at\": \"2018-07-17 23:07:41\",\n \"updated_at\": \"2019-01-23 04:50:18\",\n \"sdk_email\": \"YXdiK_g@mail.com\",\n \"sdk_key\": \"xiXnt\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 2,\n \"is_verified\": false,\n \"notifications_room_id\": \"933195\",\n \"bubble_color\": \"#1f9846\",\n \"qismo_key\": \"4NUXIq\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"line_messaging\",\n \"qiscus_messaging\",\n \"wa_messaging\",\n \"telegram_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n }\n ],\n \"type_as_string\": \"agent\",\n \"rules\": [\n {\n \"id\": 1,\n \"name\": \"fb_messaging\",\n \"created_at\": null,\n \"updated_at\": null,\n \"pivot\": {\n \"user_id\": 404,\n \"rule_id\": 1\n }\n },\n {\n \"id\": 3,\n \"name\": \"line_messaging\",\n \"created_at\": null,\n \"updated_at\": null,\n \"pivot\": {\n \"user_id\": 404,\n \"rule_id\": 3\n }\n },\n {\n \"id\": 2,\n \"name\": \"qiscus_messaging\",\n \"created_at\": null,\n \"updated_at\": null,\n \"pivot\": {\n \"user_id\": 404,\n \"rule_id\": 2\n }\n },\n {\n \"id\": 4,\n \"name\": \"wa_messaging\",\n \"created_at\": null,\n \"updated_at\": null,\n \"pivot\": {\n \"user_id\": 404,\n \"rule_id\": 4\n }\n },\n {\n \"id\": 6,\n \"name\": \"telegram_messaging\",\n \"created_at\": null,\n \"updated_at\": null,\n \"pivot\": {\n \"user_id\": 404,\n \"rule_id\": 6\n }\n }\n ]\n }\n}\nrequired
\n","type":"text"},{"key":"agent_id","value":"484","description":"required | you can get the value from allocate agent, or see Management service section
\n","type":"text"},{"key":"replace_latest_agent","value":"","description":"optional , boolean | it will remove all the agents inside room
\n","type":"text","disabled":true},{"key":"max_agent","value":"1","description":"optional|will prevent from assigning when the number of participants is equal or greater than max_agent
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/service/assign_agent","description":"Assign agent to a room
\n{\n \"data\": {\n \"added_agent\": {\n \"id\": 484,\n \"name\": \"Sip Geeto\",\n \"email\": \"sip@gmail.com\",\n \"authentication_token\": \"wU5BGofTHVnnIbOhBuEd\",\n \"created_at\": \"2018-08-30 08:31:17\",\n \"updated_at\": \"2018-10-31 01:29:38\",\n \"sdk_email\": \"zJgwo_sip@gmail.com\",\n \"sdk_key\": \"8tMLV\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 2,\n \"is_verified\": false,\n \"notifications_room_id\": \"1104503\",\n \"bubble_color\": \"#2498b2\",\n \"qismo_key\": null,\n \"type_as_string\": \"agent\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"line_messaging\",\n \"qiscus_messaging\",\n \"wa_messaging\",\n \"telegram_messaging\"\n ]\n }\n }\n}\nrequired
\n","type":"text"},{"key":"agent_id","value":"484","description":"required
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/service/remove_agent","description":"Remove agent from a room
\n{\n \"data\": {\n \"status\": \"deleted\"\n }\n}\nList of all agents that eligible in a room
\nSample Response
\n{\n \"data\": [\n {\n \"id\": 554,\n \"name\": \"Delta Purna Widyangga\",\n \"email\": \"deltapurna@gmail.com\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"is_available\": true,\n \"is_verified\": false,\n \"current_customer_count\": 19,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_rules\": [\n \"qiscus_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ],\n \"created_at\": \"2018-09-20 03:36:59\",\n \"updated_at\": \"2018-10-05 09:50:07\"\n },\n {\n \"id\": 484,\n \"name\": \"Sip Geeto\",\n \"email\": \"sip@gmail.com\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"is_available\": true,\n \"is_verified\": false,\n \"current_customer_count\": 25,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"line_messaging\",\n \"qiscus_messaging\",\n \"wa_messaging\",\n \"telegram_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n },\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ],\n \"created_at\": \"2018-08-30 08:31:17\",\n \"updated_at\": \"2018-10-31 01:29:38\"\n },\n {\n \"id\": 154,\n \"name\": \"efawan\",\n \"email\": \"efawan@gmail.com\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"is_available\": true,\n \"is_verified\": true,\n \"current_customer_count\": 83,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"qiscus_messaging\",\n \"line_messaging\",\n \"wa_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n }\n ],\n \"created_at\": \"2018-04-24 06:58:38\",\n \"updated_at\": \"2018-10-02 08:58:47\"\n }\n ]\n}\nboolean | set to true, to get agents that already joined in room
\n","type":"text/plain"},"key":"is_availalble_in_room","value":""}],"variable":[]}},"response":[],"_postman_id":"761eacf2-c571-4136-9a37-fd247581ae73"},{"name":"Mark As Resolved","id":"7cc8037f-1c79-47d8-8e37-442e5ff101e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"room_id","value":"1668912","description":"required
\n","type":"text"},{"key":"notes","value":"Pemesan nya nakal","description":"optional
\n","type":"text"},{"key":"is_send_email","value":"","description":"optional , boolean
\n","type":"text","disabled":true},{"key":"extras","value":"","description":"optional, json | give extra info to room
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/api/v1/admin/service/mark_as_resolved","description":" json { \"data\": { \"room_info\": { \"changed\": true, \"room\": { \"room_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/Cr4kwjcetd/file_23.jpg\", \"room_channel_id\": \"\", \"room_id\": \"1668912\", \"room_name\": \"Dewi\", \"room_options\": \"{\\\"notes\\\":\\\"Pemesan nya nakal\\\",\\\"extras\\\":\\\"{\\\\\\\"timezone_offset\\\\\\\":7}\\\",\\\"channel\\\":\\\"qiscus\\\",\\\"app_code\\\":\\\"ziv-nqsjtf0zdqf6kfk7s\\\",\\\"room_badge\\\":null,\\\"is_resolved\\\":true,\\\"is_handled_by_bot\\\":true}\", \"room_type\": \"group\" } } } }
boolean, required
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/service/set_sessional","description":"{\n \"data\": {\n \"is_seasonal\": false\n }\n}\n{\n \"data\": {\n \"is_seasonal\": false\n }\n}\nrequired, acceptable values : fb | qiscus | line | wa
\n","type":"text"},{"key":"ignore_availability","value":"","description":"boolean, if set to true it will get free agent regardless the agent availibility (online or offline)
\n","type":"text"},{"key":"channel_id","value":"","description":"optional, channel_id to allocate agent on specific channel
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/service/allocate_agent","description":"Get free agent (which has least customer) from allocation pool. Nb: Custom channel still not yet supported
\n{\n \"data\": {\n \"id\": 6,\n \"name\": \"Rudi\",\n \"email\": \"rudi@gmail.com\",\n \"authentication_token\": \"v2M6Ph0zJ4LG28RTeq6u\",\n \"created_at\": \"2018-10-30 03:11:06\",\n \"updated_at\": \"2019-06-26 09:56:17\",\n \"sdk_email\": \"NAYpM_rudi@gmail.com\",\n \"sdk_key\": \"wmdfd0gM\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 1,\n \"is_verified\": false,\n \"notifications_room_id\": \"1332752\",\n \"bubble_color\": \"#098511\",\n \"qismo_key\": \"mhn1SK\",\n \"direct_login_token\": null,\n \"last_login\": null,\n \"force_offline\": false,\n \"deleted_at\": null,\n \"type_as_string\": \"agent\",\n \"assigned_rules\": [\n \"line_messaging\",\n \"qiscus_messaging\",\n \"telegram_messaging\"\n ]\n }\n}\nrequired
\n","key":"room_id","type":"text","value":""},{"description":"optional
\n","key":"ignore_agent_availability","type":"text","value":""}]},"url":"{{BaseUrl}}/api/v1/admin/service/allocate_assign_agent","description":"It will allocate agent with least customer into a room that has no service/ agents. You want to use this endpoint if you have custom agent allocation service enabled.
\n\nSample Response
\n{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 76,\n \"app_id\": 1,\n \"user_id\": \"573986261\",\n \"room_id\": \"2391215\",\n \"source\": \"telegram\",\n \"created_at\": \"2019-05-08 06:25:40\",\n \"updated_at\": \"2019-05-23 08:38:08\",\n \"is_handled_by_bot\": true,\n \"start_service_comment_id\": \"23029314\",\n \"user_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/oni-bgo2lummmhvzqxbt5/image/upload/ueOCVFl6pl/file_4.jpg\",\n \"name\": \"Aji\",\n \"has_no_message\": false,\n \"extras\": null,\n \"check_wa_contact\": false,\n \"origin\": null,\n \"room_badge\": null,\n \"is_waiting\": true\n }\n ],\n \"first_page_url\": \"http://localhost:8080/api/v1/admin/service/get_unserved_rooms?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://localhost:8080/api/v1/admin/service/get_unserved_rooms?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://localhost:8080/api/v1/admin/service/get_unserved_rooms\",\n \"per_page\": 10,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}\noptional
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"optional | max = 20
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"7d5f7197-bd28-4272-a76e-aa853644741f"}],"id":"148f1bb5-4fb7-4c3c-bcf3-646190e3ec8b","description":"Agent service admin will require admin token to access all API
\n","event":[{"listen":"prerequest","script":{"id":"b7288b1c-a93b-491e-9f0f-08f61a67dfdd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e80aff9-b851-41af-95e7-3da1187b3e7a","type":"text/javascript","exec":[""]}}],"_postman_id":"148f1bb5-4fb7-4c3c-bcf3-646190e3ec8b"},{"name":"Agent","item":[{"name":"Hand over","id":"4b7322a8-2e1c-4d05-abac-f24e75d9118d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"},{"key":"Qiscus-Secret-Key","value":"{{SecretKey}}","type":"text"},{"key":"Qiscus-User-Id","value":"{{AgentEmail}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"room_id","value":"1668912","description":"required
\n","type":"text"},{"key":"agent_id","value":"154","description":"agent_id to be handed over
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/agent/service/assign_agent","description":"Hand over task / room to another agent, the current agent will removed and replaced to new requested agent
\n{\n \"data\": {\n \"added_agent\": {\n \"id\": 154,\n \"name\": \"efawan\",\n \"email\": \"efawan@gmail.com\",\n \"authentication_token\": \"Upzd8XyTqrTsDx0trzY4\",\n \"created_at\": \"2018-04-24 06:58:38\",\n \"updated_at\": \"2018-10-02 08:58:47\",\n \"sdk_email\": \"o4ZGQ_efawan@gmail.com\",\n \"sdk_key\": \"vt7Jr\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 2,\n \"is_verified\": true,\n \"notifications_room_id\": \"983459\",\n \"bubble_color\": \"#33abb1\",\n \"qismo_key\": null,\n \"type_as_string\": \"agent\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"qiscus_messaging\",\n \"line_messaging\",\n \"wa_messaging\"\n ]\n }\n }\n}\nList of all online agents that eligible in a room
\nSample Response
\n{\n \"data\": [\n {\n \"id\": 554,\n \"name\": \"Delta Purna Widyangga\",\n \"email\": \"deltapurna@gmail.com\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"is_available\": true,\n \"is_verified\": false,\n \"current_customer_count\": 19,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_rules\": [\n \"qiscus_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ],\n \"created_at\": \"2018-09-20 03:36:59\",\n \"updated_at\": \"2018-10-05 09:50:07\"\n },\n {\n \"id\": 484,\n \"name\": \"Sip Geeto\",\n \"email\": \"sip@gmail.com\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"is_available\": true,\n \"is_verified\": false,\n \"current_customer_count\": 25,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"line_messaging\",\n \"qiscus_messaging\",\n \"wa_messaging\",\n \"telegram_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n },\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ],\n \"created_at\": \"2018-08-30 08:31:17\",\n \"updated_at\": \"2018-10-31 01:29:38\"\n },\n {\n \"id\": 154,\n \"name\": \"efawan\",\n \"email\": \"efawan@gmail.com\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"is_available\": true,\n \"is_verified\": true,\n \"current_customer_count\": 83,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"qiscus_messaging\",\n \"line_messaging\",\n \"wa_messaging\"\n ],\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n }\n ],\n \"created_at\": \"2018-04-24 06:58:38\",\n \"updated_at\": \"2018-10-02 08:58:47\"\n }\n ]\n}\nboolean | set to true, to get all agent that already joined in room
\n","type":"text/plain"},"key":"is_available_in_room","value":null}],"variable":[]}},"response":[],"_postman_id":"1be23d1a-6c75-4e0e-b475-3200af9c7a8b"},{"name":"Mark As Resolved","id":"da00ca0d-5b21-4b29-943c-5d510a15cd2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AdminToken}}","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"room_id","value":"1668912","description":"required
\n","type":"text"},{"key":"notes","value":"Pemesan nya nakal","description":"optional
\n","type":"text"},{"key":"is_send_email","value":"","description":"optional , boolean
\n","type":"text","disabled":true},{"key":"extras","value":"","description":"optional, json | give extra info to room
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/api/v1/agent/service/mark_as_resolved","description":" json { \"data\": { \"room_info\": { \"changed\": true, \"room\": { \"room_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/Cr4kwjcetd/file_23.jpg\", \"room_channel_id\": \"\", \"room_id\": \"1668912\", \"room_name\": \"Dewi\", \"room_options\": \"{\\\"notes\\\":\\\"Pemesan nya nakal\\\",\\\"extras\\\":\\\"{\\\\\\\"timezone_offset\\\\\\\":7}\\\",\\\"channel\\\":\\\"qiscus\\\",\\\"app_code\\\":\\\"ziv-nqsjtf0zdqf6kfk7s\\\",\\\"room_badge\\\":null,\\\"is_resolved\\\":true,\\\"is_handled_by_bot\\\":true}\", \"room_type\": \"group\" } } } }
Get unserved customer from queue
\n{\n \"data\": {\n \"total_unresolved\": 12\n }\n}\noptional , boolean
\n","type":"text","disabled":true},{"key":"extras","value":"","description":"optional, json | give extra info to room
\n","type":"text","disabled":true}]},"url":"{{BaseUrl}}/api/v1/agent/service/get_unresolved_count","description":"{\n \"data\": {\n \"total_unresolved\": 12\n }\n}\nAgent service agent will require admin token to access all API
\n","event":[{"listen":"prerequest","script":{"id":"353a191d-3d80-404c-a065-dd314d64f2a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6cdb2568-61a1-42f1-9bc7-0d01a9de31d7","type":"text/javascript","exec":[""]}}],"_postman_id":"76fc50b2-120a-481a-a3ae-9615c1d686e6"}],"id":"fda2fd65-b963-41b2-ba2d-0e1e97c21eb9","event":[{"listen":"prerequest","script":{"id":"8c0f3f30-c5df-4e7f-9cff-8aa95ed704aa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ee976b7-ce66-4eb0-877e-eefca4692d80","type":"text/javascript","exec":[""]}}],"_postman_id":"fda2fd65-b963-41b2-ba2d-0e1e97c21eb9","description":""},{"name":"Profile","item":[{"name":"Agent","item":[{"name":"Get Profile","id":"78ca2e2b-bb79-46aa-adcc-a42445d39549","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{AgentToken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"}],"url":"{{BaseUrl}}/api/v1/agent/get_profile","description":"Get agent profile
\n{\n \"data\": {\n \"name\": \"Sip Geeto\",\n \"email\": \"sip@gmail.com\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n },\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ]\n }\n}\nrequired
\n","type":"text"},{"key":"email","value":"sip@gmail.com","description":"required
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/agent/update_profile","description":"\nrequired
\n","type":"text"},{"key":"new_password","value":"password123","description":"required
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/agent/change_password","description":"Change agent password
\n{\"data\":\"Password changed, please logout to get access to your account again\"}\nGet agent profile
\n{\n \"data\": {\n \"name\": \"Sip Geeto\",\n \"email\": \"sip@gmail.com\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/D1se5xo40I/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"assigned_agent_roles\": [\n {\n \"id\": 181,\n \"name\": \"General\",\n \"is_default_role\": true\n },\n {\n \"id\": 197,\n \"name\": \"Supervisor\",\n \"is_default_role\": false\n }\n ]\n }\n}\n{\n \"data\": {\n \"user\": {\n \"id\": 2,\n \"name\": \"Aji Tirta\",\n \"email\": \"qiscus_69f45_qismo.demo@gmail.com\",\n \"authentication_token\": \"evusPVPaYYFE3DwKm4la\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2019-02-01 02:39:43\",\n \"sdk_email\": \"ziv-nqsjtf0zdqf6kfk7s_admin@qismo.com\",\n \"sdk_key\": \"d283c\",\n \"is_available\": true,\n \"type\": 1,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/jKvSjCP6Gr/customer-support.png\",\n \"app_id\": 2,\n \"is_verified\": true,\n \"notifications_room_id\": \"932825\",\n \"bubble_color\": \"#1CFF3F\",\n \"qismo_key\": \"lB6pqF\",\n \"direct_login_token\": null,\n \"billing_emails\": [\n {\n \"id\": 15,\n \"user_id\": 2,\n \"email\": \"ahyana1995@gmail.com\",\n \"created_at\": \"2019-02-01 02:39:43\",\n \"updated_at\": \"2019-02-01 02:39:43\"\n }\n ],\n \"type_as_string\": \"admin\",\n \"assigned_rules\": [],\n \"app\": {\n \"id\": 2,\n \"name\": null,\n \"app_code\": \"ziv-nqsjtf0zdqf6kfk7s\",\n \"secret_key\": \"fd36b23d5198ae3eaadd0f5b59163d32\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2018-12-04 02:08:31\",\n \"bot_webhook_url\": \"https://kanal.kata.ai/receive_message/0a5200c4-9d38-4f9e-b7b3-0f8ae2e68124\",\n \"is_bot_enabled\": true,\n \"allocate_agent_webhook_url\": null,\n \"is_allocate_agent_webhook_enabled\": false,\n \"mark_as_resolved_webhook_url\": \"https://telek.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": false,\n \"is_mobile_pn_enabled\": true,\n \"is_active\": true\n },\n \"dashboard_credential\": {\n \"id\": 2,\n \"email\": \"qismo.demo@gmail.com\",\n \"token\": \"rgqmRHWbFkegGktkq6uT\",\n \"user_id\": 2,\n \"created_at\": \"2018-01-15 03:10:29\",\n \"updated_at\": \"2019-02-01 02:39:43\",\n \"company_name\": \"Aji Co\",\n \"phone_number\": null,\n \"address\": null,\n \"stripe_id\": null,\n \"payment_method_id\": 2\n }\n },\n \"admin_account\": {\n \"id\": 2,\n \"email\": \"qismo.demo@gmail.com\",\n \"token\": \"rgqmRHWbFkegGktkq6uT\",\n \"user_id\": 2,\n \"created_at\": \"2018-01-15 03:10:29\",\n \"updated_at\": \"2019-02-01 02:39:43\",\n \"company_name\": \"Aji Co\",\n \"phone_number\": null,\n \"address\": null,\n \"stripe_id\": null,\n \"payment_method_id\": 2\n },\n \"sdk_user\": {\n \"id\": 672539,\n \"token\": \"Iz9xetGy5wIj1O2Ao7Ly\",\n \"email\": \"ziv-nqsjtf0zdqf6kfk7s_admin@qismo.com\",\n \"password\": \"d283c\",\n \"display_name\": \"Aji Tirta\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/jKvSjCP6Gr/customer-support.png\",\n \"last_comment_received_id\": 14781320\n }\n }\n}\nrequired
\n","type":"text"},{"key":"new_password","value":"12345678qismo","description":"required
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/admin/change_password","description":"Change agent password
\n{\"data\":\"Password changed, please logout to get access to your account again\"}\nrequired, boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/set_availability","description":"{\n \"data\": {\n \"id\": 2,\n \"name\": \"Aji Tirta\",\n \"email\": \"qiscus_69f45_qismo.demo@gmail.com\",\n \"authentication_token\": \"lVoR8GVXBtrzmfCdGFbG\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2019-02-01 02:43:00\",\n \"sdk_email\": \"ziv-nqsjtf0zdqf6kfk7s_admin@qismo.com\",\n \"sdk_key\": \"d283c\",\n \"is_available\": true,\n \"type\": 1,\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/ziv-nqsjtf0zdqf6kfk7s/image/upload/jKvSjCP6Gr/customer-support.png\",\n \"app_id\": 2,\n \"is_verified\": true,\n \"notifications_room_id\": \"932825\",\n \"bubble_color\": \"#1CFF3F\",\n \"qismo_key\": \"lB6pqF\",\n \"direct_login_token\": null,\n \"type_as_string\": \"admin\",\n \"assigned_rules\": [],\n \"app\": {\n \"id\": 2,\n \"name\": null,\n \"app_code\": \"ziv-nqsjtf0zdqf6kfk7s\",\n \"secret_key\": \"fd36b23d5198ae3eaadd0f5b59163d32\",\n \"created_at\": \"2018-01-15 03:10:30\",\n \"updated_at\": \"2018-12-04 02:08:31\",\n \"bot_webhook_url\": \"https://kanal.kata.ai/receive_message/0a5200c4-9d38-4f9e-b7b3-0f8ae2e68124\",\n \"is_bot_enabled\": true,\n \"allocate_agent_webhook_url\": null,\n \"is_allocate_agent_webhook_enabled\": false,\n \"mark_as_resolved_webhook_url\": \"https://telek.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": false,\n \"is_mobile_pn_enabled\": true,\n \"is_active\": true\n }\n }\n}\n{\n \"data\": {\n \"is_available\": false\n }\n}\n{\n \"data\": {\n \"bot_webhook_url\": null,\n \"is_bot_enabled\": false\n }\n}\njson { \"data\": { \"app\": { \"id\": 1, \"name\": null, \"app_code\": \"oni-bgo2lummmhvzqxbt5\", \"secret_key\": \"9fcb41b1dc222d889810d06599cec062\", \"created_at\": \"2018-10-29 09:02:43\", \"updated_at\": \"2019-02-01 08:26:36\", \"bot_webhook_url\": \"https://www.google.com\", \"is_bot_enabled\": false, \"allocate_agent_webhook_url\": null, \"is_allocate_agent_webhook_enabled\": false, \"mark_as_resolved_webhook_url\": null, \"is_mark_as_resolved_webhook_enabled\": false, \"is_mobile_pn_enabled\": false, \"is_active\": true } } }
boolean|required
\n","key":"is_active","type":"text","value":""}]},"url":"{{BaseUrl}}/bot/{{RoomId}}/activate","description":"Turn on/off bot interaction in a room
\n","urlObject":{"path":["bot","{{RoomId}}","activate"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"67a2722d-5abc-4e58-8352-d6a9f3c42d72"},{"name":"Hand Over ","id":"91e6647a-ae5b-4a8c-9f3d-180e13297870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{appSecretKey}}","type":"text"}],"url":"{{BaseUrl}}/{{appCode}}/bot/{{roomId}}/hand_over","description":"Turn off bot interaction in a room, and notify agent in charge
\n","urlObject":{"path":["{{appCode}}","bot","{{roomId}}","hand_over"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91e6647a-ae5b-4a8c-9f3d-180e13297870"},{"name":"Hand Over To Role","id":"80a4a480-f9f0-42f7-ba0f-7df5967bde07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{appSecretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"role","value":"","description":"required
\n","type":"text"},{"key":"roles[]","value":"","description":"required if role empty | array
\n","type":"text"},{"key":"find_online_agent","value":"","description":"optional|boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/eme-a6r2fzw5lbrbqtgeg/bot/{{roomId}}/hand_over_to_role","urlObject":{"path":["eme-a6r2fzw5lbrbqtgeg","bot","{{roomId}}","hand_over_to_role"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80a4a480-f9f0-42f7-ba0f-7df5967bde07"},{"name":"Send Message Text","id":"7efdd07d-f731-49f7-8bf3-a69c8ce08532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"QISCUS_SDK_SECRET","value":"{{AppSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"sender_email\": \"{{AdminEmail}}\", \n\t\"message\": \"Hi good morning\",\n\t\"type\": \"text\",\n\t\"room_id\": \"2174484\"\n}"},"url":"{{BaseUrl}}/{{AppCode}}/bot","urlObject":{"path":["{{AppCode}}","bot"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7efdd07d-f731-49f7-8bf3-a69c8ce08532"},{"name":"Send Message Attachment","id":"a3fe4202-c8b5-44bd-9923-938983b1ce7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"QISCUS_SDK_SECRET","value":"{{AppSecret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"sender_email\": \"{{AdminEmail}}\", \n\t\"message\": \"Hi good morning\",\n\t\"type\": \"file_attachment\",\n\t\"room_id\": \"2174484\",\n\t\"payload\": {\n\t\t\"url\": \"https://www.solopos.com/assets/images/solopos.jpg\",\n\t\t\"caption\": \"Ini gambar siapa?\"\n\t}\n}"},"url":"{{BaseUrl}}/{{AppCode}}/bot","urlObject":{"path":["{{AppCode}}","bot"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3fe4202-c8b5-44bd-9923-938983b1ce7f"},{"name":"Send Message Button","id":"81f95970-3de7-45e8-90a9-980770953900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"QISCUS_SDK_SECRET","type":"text","value":"{{AppSecret}}"}],"body":{"mode":"raw","raw":"{\n\t\"sender_email\": \"{{AdminEmail}}\", \n\t\"message\": \"Hi good morning\",\n\t\"type\": \"buttons\",\n\t\"room_id\": \"2174484\",\n\t\"payload\": {\n\t\t\"text\": \"silahkan pencet\",\n\t \"buttons\": [\n\t {\n\t \"label\": \"button1\",\n\t \"type\": \"postback\",\n\t \"payload\": {\n\t \"url\": \"http://somewhere.com/button1\",\n\t \"method\": \"get\",\n\t \"payload\": null\n\t }\n\t },\n\t {\n\t \"label\": \"button2\",\n\t \"type\": \"link\",\n\t \"payload\": {\n\t \"url\": \"http://somewhere.com/button2?id=123\"\n\t }\n\t }\n\t\t]\n\t}\n}"},"url":"{{BaseUrl}}/{{AppCode}}/bot","description":"nb: not available on wa channel
nb: not available on wa channel
nb: only available on line, facebook and telegram
nb: only available on Whatsapp channel
url for sticker must be :
\n“content-type”: “image/webp”nb: only available on Whatsapp channel
url for sticker must be :
\n“content-type”: “image/webp”{\n \"app_id\": \"oni-bgo2lummmhvzqxbt5\",\n \"source\": \"qiscus\",\n \"name\": \"sudah\",\n \"email\": \"sudah@gmail.com\",\n \"avatar_url\": \"https:\\/\\/d1edrlpyc25xu0.cloudfront.net\\/kiwari-prod\\/image\\/upload\\/wMWsDZP6ta\\/1516689726-ic_qiscus_client.png\",\n \"extras\": \"{\\\"timezone_offset\\\":7}\",\n \"is_resolved\": true,\n \"latest_service\": {\n \"id\": 244,\n \"user_id\": 1,\n \"room_log_id\": 53,\n \"app_id\": 1,\n \"room_id\": \"1905692\",\n \"notes\": null,\n \"resolved_at\": \"2019-02-04 04:49:47\",\n \"is_resolved\": true,\n \"created_at\": \"2019-02-04 04:49:47\",\n \"updated_at\": \"2019-02-04 04:49:47\",\n \"first_comment_id\": \"15167003\",\n \"last_comment_id\": \"15167015\",\n \"retrieved_at\": \"2019-02-04 04:49:47\",\n \"first_comment_timestamp\": null\n },\n \"room_id\": \"1905692\",\n \"candidate_agent\": {\n \"id\": 22,\n \"name\": \"dewi\",\n \"email\": \"dewi@mail.com\",\n \"authentication_token\": \"NlASwSIUnAqoTcFjYNBR\",\n \"created_at\": \"2019-01-17 06:50:20\",\n \"updated_at\": \"2019-01-18 10:12:59\",\n \"sdk_email\": \"vsC6x_dewi@mail.com\",\n \"sdk_key\": \"NZTGb\",\n \"is_available\": true,\n \"type\": 2,\n \"avatar_url\": \"https:\\/\\/d1edrlpyc25xu0.cloudfront.net\\/kiwari-prod\\/image\\/upload\\/D1se5xo40I\\/1516941944-Screen_Shot_2018-01-26_at_11.45.20.png\",\n \"app_id\": 1,\n \"is_verified\": false,\n \"notifications_room_id\": \"1692312\",\n \"bubble_color\": \"#666666\",\n \"qismo_key\": \"43Ondc\",\n \"direct_login_token\": null,\n \"type_as_string\": \"agent\",\n \"assigned_rules\": [\n \"fb_messaging\",\n \"line_messaging\",\n \"qiscus_messaging\",\n \"wa_messaging\",\n \"telegram_messaging\"\n ]\n }\n}\n\n{\n \"data\": {\n \"config\": {\n \"id\": 16,\n \"app_id\": 1,\n \"widget\": null,\n \"created_at\": \"2019-07-22 04:27:49\",\n \"updated_at\": \"2019-07-29 06:53:25\",\n \"offline_message\": \"yo offlen\",\n \"online_message\": \"yo onlen\",\n \"timezone\": \"+07:00\",\n \"enable_bulk_assign\": false,\n \"bot_webhook_url\": \"https://salaman.free.beeceptor.com\",\n \"is_bot_enabled\": true,\n \"is_allocate_agent_webhook_enabled\": false,\n \"allocate_agent_webhook_url\": \"https://sedih.free.beeceptor.com\",\n \"mark_as_resolved_webhook_url\": \"https://ponorogo.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": true,\n \"is_active\": true,\n \"is_sessional\": true,\n \"is_agent_allocation_enabled\": true,\n \"is_agent_takeover_enabled\": true\n }\n }\n}\n{\n \"data\": {\n \"online_message\": \"abc\",\n \"offline_message\": \"bca\",\n \"timezone\": \"+07.00\",\n \"office_hours\": [\n {\n \"id\": 104,\n \"app_id\": 1,\n \"day\": 6,\n \"startime\": \"06:44:00\",\n \"endtime\": \"08:44:00\",\n \"created_at\": \"2019-02-27 08:53:30\",\n \"updated_at\": \"2019-02-27 08:53:30\"\n }\n ]\n }\n}\nSample Response
\n{\n \"data\": {\n \"online_message\": \"abc\",\n \"offline_message\": \"bca\",\n \"timezone\": \"+07.00\",\n \"office_hours\": [\n {\n \"id\": 104,\n \"app_id\": 1,\n \"day\": 6,\n \"startime\": \"06:44:00\",\n \"endtime\": \"08:44:00\",\n \"created_at\": \"2019-02-27 08:53:30\",\n \"updated_at\": \"2019-02-27 08:53:30\"\n }\n ]\n }\n}\n{\n \"data\": {\n \"is_sessional\": true\n }\n}\n{\n \"data\": [\n {\n \"url\": \"www.perusahaanC.com\",\n \"name\": \"\",\n \"enabled\": true\n }\n ]\n}\nnullable
\n","type":"text"},{"key":"name","value":"perusahaanA","description":"nullable
\n","type":"text"},{"key":"enabled","value":"true","description":"nullable|boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/pre_defined_text/store","description":"{\n \"data\": [\n {\n \"url\": \"www.perusahaanA.com\",\n \"name\": \"\",\n \"enabled\": true\n }\n ]\n}\nrequired|boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/pre_defined_text/config","description":"{\n \"data\": {\n \"enabled\": true\n }\n}\nrequired|url
\n","type":"text"},{"key":"is_webhook_enabled","value":"","description":"optional|boolean
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v1/app/webhook/mark_as_resolved","description":"{\n \"data\": {\n \"id\": 609,\n \"name\": null,\n \"app_code\": \"ysotr-aja9u91emy3ecss\",\n \"secret_key\": \"7f7edd86eff6bef9e713ba4c98580a84\",\n \"created_at\": \"2019-02-01 07:02:42\",\n \"updated_at\": \"2019-02-19 07:43:16\",\n \"bot_webhook_url\": null,\n \"is_bot_enabled\": false,\n \"allocate_agent_webhook_url\": null,\n \"is_allocate_agent_webhook_enabled\": false,\n \"mark_as_resolved_webhook_url\": \"https://qismo.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": true,\n \"is_mobile_pn_enabled\": false,\n \"is_active\": true\n }\n}\n{\n \"service\": {\n \"id\": 237788,\n \"room_id\": \"1961380\",\n \"is_resolved\": true,\n \"notes\": null,\n \"first_comment_id\": \"15828799\",\n \"last_comment_id\": 15828825,\n \"source\": \"qiscus\"\n },\n \"resolved_by\": {\n \"id\": 1576,\n \"email\": \"qiscus_3822b_dewianisaist@qiscus.com\",\n \"name\": \"Dewi Corp\",\n \"type\": \"admin\",\n \"is_available\": true\n },\n \"customer\": {\n \"user_id\": \"auliaollegh@gmail.com\"\n }\n}\noptional|boolean
\n","key":"is_enabled","type":"text","value":""}]},"url":"{{BaseUrl}}/api/v1/app/config/agent_allocation","description":"{\n \"data\": {\n \"id\": 609,\n \"name\": null,\n \"app_code\": \"ysotr-aja9u91emy3ecss\",\n \"secret_key\": \"7f7edd86eff6bef9e713ba4c98580a84\",\n \"created_at\": \"2019-02-01 07:02:42\",\n \"updated_at\": \"2019-02-19 07:43:16\",\n \"bot_webhook_url\": null,\n \"is_bot_enabled\": false,\n \"allocate_agent_webhook_url\": null,\n \"is_allocate_agent_webhook_enabled\": false,\n \"mark_as_resolved_webhook_url\": \"https://qismo.free.beeceptor.com\",\n \"is_mark_as_resolved_webhook_enabled\": true,\n \"is_mobile_pn_enabled\": false,\n \"is_active\": true\n }\n}\n{\n \"service\": {\n \"id\": 237788,\n \"room_id\": \"1961380\",\n \"is_resolved\": true,\n \"notes\": null,\n \"first_comment_id\": \"15828799\",\n \"last_comment_id\": 15828825,\n \"source\": \"qiscus\"\n },\n \"resolved_by\": {\n \"id\": 1576,\n \"email\": \"qiscus_3822b_dewianisaist@qiscus.com\",\n \"name\": \"Dewi Corp\",\n \"type\": \"admin\",\n \"is_available\": true\n },\n \"customer\": {\n \"user_id\": \"auliaollegh@gmail.com\"\n }\n}\n{\n \"data\": {\n \"is_sku\": xxx,\n \"sku_expired_date\": \"2023-0xxx\",\n \"name\": \"Plan Name\",\n \"monthly_price\": \"xxxx\",\n \"annual_price\": \"xxx\",\n \"mau_limit\": 1xx0,\n \"admin_agent_limit\": 1xxx,\n \"currency\": \"xxx\",\n \"subscription_date\": \"20xx-0x-13\",\n \"subscription_type\": \"sixmonthly\",\n \"subscription_status\": \"active\",\n \"extra_mau\": 0,\n \"extra_mau_charge\": \"0\",\n \"trial_remaining_days\": null,\n \"usage_info\": {\n \"mau_usage\": 1xx,\n \"admin_agent_usage\": 5xx,\n \"extra_mau\": 0,\n \"extra_mau_charge\": 0,\n \"current_mau\": 1xx\n },\n \"max_wa_channel\": 1x\n }\n}\n\neither Admin, Supervisor, or Admin token can be used
\n","type":"text"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"}],"url":"{{BaseUrl}}/api/v1/chat_templates","urlObject":{"path":["api","v1","chat_templates"],"host":["{{BaseUrl}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"81c65570-b1dc-408a-9799-13197f82afd2"},{"name":"Create Chat Template","id":"42481d93-7063-47a5-9013-bb4a205baf62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{AdminToken}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Qiscus-App-Id","value":"{{AppCode}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"command","value":"helos#1","type":"text"},{"key":"message","value":"hi this is me","type":"text"}]},"url":"{{BaseUrl}}/api/v1/chat_templates/create","description":"{\n \"data\": {\n \"command\": \"helos#1\",\n \"message\": \"hi this is me\",\n \"app_id\": 1,\n \"updated_at\": \"2019-03-04 05:15:53\",\n \"created_at\": \"2019-03-04 05:15:53\",\n \"id\": 4\n }\n}\n{\n \"data\": {\n \"id\": 1,\n \"command\": \"heleh\",\n \"message\": \"hi this is me\",\n \"app_id\": 1,\n \"created_at\": \"2019-03-04 05:09:56\",\n \"updated_at\": \"2019-03-04 05:27:29\"\n }\n}\n\n{\n \"data\": {\n \"message\": \"data has been deleted\"\n }\n}\nSample Response
\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"Hi good morning\",\n \"payload\": {},\n \"timestamp\": \"2019-04-23T04:03:59Z\",\n \"type\": \"text\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"[file] https://www.solopos.com/assets/images/solopos.jpg [/file]\",\n \"payload\": {\n \"url\": \"https://www.solopos.com/assets/images/solopos.jpg\",\n \"caption\": \"Ini gambar siapa?\",\n \"file_name\": \"\",\n \"size\": 0,\n \"pages\": 1,\n \"encryption_key\": \"\"\n },\n \"timestamp\": \"2019-04-26T07:48:45Z\",\n \"type\": \"file_attachment\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"Hi good morning\",\n \"payload\": {\n \"text\": \"silahkan pencet\",\n \"buttons\": [\n {\n \"label\": \"button1\",\n \"postback_text\": \"\",\n \"type\": \"postback\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button1\",\n \"method\": \"get\",\n \"payload\": null\n }\n },\n {\n \"label\": \"button2\",\n \"postback_text\": \"\",\n \"type\": \"link\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button2?id=123\",\n \"method\": \"\",\n \"payload\": null\n }\n }\n ]\n },\n \"timestamp\": \"2019-04-26T07:58:40Z\",\n \"type\": \"buttons\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"Hi good morning\",\n \"payload\": {\n \"cards\": [\n {\n \"image\": \"http://url.com/gambar.jpg\",\n \"title\": \"Atasan Blouse Tunik Wanita Baju Muslim Worie Longtop\",\n \"description\": \"Oleh sippnshop\\n96% (666 feedback)\\nRp 49.000.00,-\\nBUY 2 GET 1 FREE!!!\",\n \"default_action\": {\n \"type\": \"postback\",\n \"postback_text\": \"Load more\",\n \"payload\": {\n \"url\": \"http://url.com/baju?id=123&track_from_chat_room=123\",\n \"method\": \"get\",\n \"payload\": null\n }\n },\n \"buttons\": [\n {\n \"label\": \"button1\",\n \"postback_text\": \"Load more\",\n \"type\": \"postback\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button1\",\n \"method\": \"get\",\n \"payload\": null\n }\n },\n {\n \"label\": \"button2\",\n \"postback_text\": \"\",\n \"type\": \"link\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button2?id=123\",\n \"method\": \"get\",\n \"payload\": null\n }\n }\n ]\n }\n ]\n },\n \"timestamp\": \"2019-04-26T08:10:25Z\",\n \"type\": \"carousel\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\nWe're encouraging all of you to upgrade custom channel api to v2 to keep up with new agent allocation logic
{\n \"type\": \"post_comment_mobile\", // either type \"post_comment_mobile\" if from client side or \"post_comment_rest\" if from REST API\n \"payload\": {\n \"from\": {\n \"id\": 1,\n \"email\": \"user1@gmail.com\",\n \"name\": \"User1\",\n },\n \"room\": {\n \"id\": 1,\n \"topic_id\": 1,\n \"type\": \"group\", # can also be single\n \"name\": \"ini grup\",\n \"options\": {\n \"is_resolved\": true,\n \"source\": \"wa\",\n \"is_waiting\": \"false\",\n \"channel_details\": {\n \"channel_id\": 1,\n \"name\": \"Wa Pertama\"\n }\n },\n \"participants\": [\n {\n \"id\": 1,\n \"email\": \"user1@gmail.com\",\n \"username\": \"User1\",\n \"avatar_url\": \"http://avatar1.jpg\"\n },\n {\n \"id\": 2,\n \"email\": \"user2@gmail.com\",\n \"username\": \"User2\",\n \"avatar_url\": \"http://avatar2.jpg\"\n }\n ]\n },\n \"message\": {\n \"type\": \"text\",\n \"text\": \"ini pesan\",\n \"payload\": {\n # comment type specific payload\n }\n }\n }\n}\n{\n \"data\": {\n \"download_url\": \"https://d1edrlpyc25xu0.cloudfront.net/oni-bgo2lummmhvzqxbt5/raw/upload/mteTMsv0PI/7500d.txt\"\n }\n}\n{\n \"data\": {\n \"customer_rooms\": [\n {\n \"channel_id\": 23,\n \"id\": 315,\n \"is_handled_by_bot\": true,\n \"is_resolved\": true,\n \"is_waiting\": false,\n \"last_comment_text\": \"qwe\",\n \"last_comment_timestamp\": \"2020-01-06 02:37:48\",\n \"name\": \"932186238\",\n \"phone_number\": null,\n \"room_badge\": null,\n \"room_id\": \"7700975\",\n \"source\": \"wa\",\n \"user_avatar_url\": \"https://image.flaticon.com/icons/svg/145/145867.svg\",\n \"user_id\": \"932186238\"\n }\n ]\n },\n \"meta\": {\n \"current_total\": 1,\n \"cursor_after\": \"2020-01-06 02:37:48\",\n \"cursor_before\": \"2020-01-06 02:37:48\"\n },\n \"status\": 200\n}\n{\n \"data\": {\n \"customer_room\": {\n \"channel_id\": 1,\n \"id\": 127,\n \"is_handled_by_bot\": true,\n \"is_resolved\": true,\n \"is_waiting\": false,\n \"last_comment_text\": null,\n \"last_comment_timestamp\": \"2019-11-19 00:00:00\",\n \"last_customer_timestamp\": null,\n \"name\": \"nibba4\",\n \"room_badge\": null,\n \"room_id\": \"3320049\",\n \"source\": \"qiscus\",\n \"user_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"user_id\": \"nigga4@nibba.com\"\n }\n },\n \"status\": 200\n}\nSample Response
\n{\n \"data\": {\n \"agents\": [\n {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/topa-kxk1fot1mqxboyip/image/upload/kVF9AoINBd/file_8.jpg\",\n \"email\": \"apiepsatu9@mail.com\",\n \"force_offline\": false,\n \"id\": 66,\n \"is_available\": false,\n \"last_login\": null,\n \"name\": \"apiepsatudua\",\n \"sdk_email\": \"hQMif_apiepsatu9@mail.com\",\n \"sdk_key\": \"9f-a7b9-15c8c7ab\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"user_channels\": [\n {\n \"id\": 14,\n \"name\": \"wa\"\n }\n ],\n \"user_roles\": [\n {\n \"id\": 1,\n \"name\": \"General\"\n }\n ]\n }\n ],\n \"meta\": {\n \"after\": \"g2wAAAACdAAAAAlkAApfX3N0cnVjdF9fZAAURWxpeGlyLk5haXZlRGF0ZVRpbWVkAAhjYWxlbmRhcmQAE0VsaXhpci5DYWxlbmRhci5JU09kAANkYXlhEmQABGhvdXJhBmQAC21pY3Jvc2Vjb25kaAJhAGEAZAAGbWludXRlYSVkAAVtb250aGEKZAAGc2Vjb25kYQFkAAR5ZWFyYgAAB-NkAAVmYWxzZWo=\",\n \"before\": null,\n \"per_page\": 1,\n \"total_count\": 19\n }\n },\n \"status\": 200\n}\noptional
\n","type":"text/plain"},"key":"cursor_before","value":""},{"description":{"content":"optional
\n","type":"text/plain"},"key":"cursor_after","value":""},{"description":{"content":"optional|default:10
\n","type":"text/plain"},"key":"limit","value":null},{"key":"search","value":null},{"description":{"content":"either division, email, or name or let by default
{\n \"email\": \"apiepsatu2@mail.com\",\n \"name\": \"apiepsatu\",\n \"password\": \"password\",\n \"channels\": [\n {\n \"channel_id\": 1,\n \"source\": \"wa\"\n }\n ],\n \"is_supervisor\": false,\n \"role_ids\": [\n 1\n ],\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/topa-kxk1fot1mqxboyip/image/upload/kVF9AoINBd/file_8.jpg\"\n}\n{\n \"data\": {\n \"agent\": {\n \"id\": 61,\n \"name\": \"apiepsatu\",\n \"user_channels\": [\n {\n \"channel_id\": 14,\n \"source\": \"wa\"\n }\n ],\n \"email\": \"apiepsatu4@mail.com\",\n \"is_available\": false,\n \"sdk_email\": \"KTM0d_apiepsatu4@mail.com\",\n \"sdk_key\": \"45-ac1d-b8523bed\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/topa-kxk1fot1mqxboyip/image/upload/kVF9AoINBd/file_8.jpg\",\n \"is_verified\": null,\n \"force_offline\": null,\n \"last_login\": null,\n \"created_at\": \"2019-10-17T09:19:10\",\n \"updated_at\": \"2019-10-17T09:19:10\",\n \"user_roles\": [\n {\n \"id\": 1,\n \"name\": \"General\"\n }\n ]\n }\n }\n}\n{\n \"email\": \"apiepsatu9@mail.com\",\n \"name\": \"apiepsatudua\",\n \"password\": \"password\",\n \"channels\": [\n {\n \"channel_id\": 14,\n \"source\": \"wa\"\n }\n ],\n \"is_supervisor\": true,\n \"role_ids\": [\n 1\n ],\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/topa-kxk1fot1mqxboyip/image/upload/kVF9AoINBd/file_8.jpg\"\n}\n{\n \"data\": {\n \"agent\": {\n \"id\": 66,\n \"name\": \"apiepsatudua\",\n \"user_channels\": [\n {\n \"channel_id\": 14,\n \"source\": \"wa\"\n }\n ],\n \"email\": \"apiepsatu9@mail.com\",\n \"is_available\": false,\n \"sdk_email\": \"hQMif_apiepsatu9@mail.com\",\n \"sdk_key\": \"9f-a7b9-15c8c7ab\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/topa-kxk1fot1mqxboyip/image/upload/kVF9AoINBd/file_8.jpg\",\n \"is_verified\": false,\n \"force_offline\": false,\n \"last_login\": null,\n \"created_at\": \"2019-10-18T06:37:01\",\n \"updated_at\": \"2019-10-18T09:08:06\",\n \"user_roles\": [\n {\n \"id\": 1,\n \"name\": \"General\"\n }\n ]\n }\n }\n}\n{\n \"data\": {\n \"agent\": {\n \"id\": 66,\n \"name\": \"apiepsatudua\",\n \"user_channels\": [\n {\n \"channel_id\": 14,\n \"source\": \"wa\"\n }\n ],\n \"email\": \"apiepsatu9@mail.com\",\n \"is_available\": false,\n \"sdk_email\": \"hQMif_apiepsatu9@mail.com\",\n \"sdk_key\": \"9f-a7b9-15c8c7ab\",\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/topa-kxk1fot1mqxboyip/image/upload/kVF9AoINBd/file_8.jpg\",\n \"is_verified\": false,\n \"force_offline\": false,\n \"last_login\": null,\n \"created_at\": \"2019-10-18T06:37:01\",\n \"updated_at\": \"2019-10-18T09:08:06\",\n \"user_roles\": [\n {\n \"id\": 1,\n \"name\": \"General\"\n }\n ]\n }\n }\n}\nSample Response
\n{\n \"data\": [\n {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/20.png\",\n \"current_customer_count\": 0,\n \"email\": \"yeye@mail.com\",\n \"force_offline\": false,\n \"id\": 1148,\n \"is_available\": true,\n \"last_login\": \"2020-03-17T09:24:41Z\",\n \"name\": \"<H1>tralala</H1>\",\n \"sdk_email\": \"d8x3j_yeye@mail.com\",\n \"sdk_key\": \"a4-a8ba-ef988d58\",\n \"type\": 2,\n \"type_as_string\": \"agent\",\n \"user_channels\": [],\n \"user_roles\": [\n {\n \"id\": 122,\n \"name\": \"General\"\n },\n {\n \"id\": 133,\n \"name\": \"Marketing\"\n }\n ]\n }\n ],\n \"meta\": {\n \"limit\": 10,\n \"page\": 1,\n \"total\": 1,\n \"total_page\": 1\n }\n}\noptional, default: 1
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"optional, max: 100, default: 10
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"array of division_id, can be multiple with rule AND / &&
\n","type":"text/plain"},"key":"division_ids[]","value":"438"},{"disabled":true,"key":"division_ids[]","value":"530"},{"description":{"content":"online availability filter, default all, can be true of false
\n","type":"text/plain"},"key":"is_available","value":"true"},{"description":{"content":"default asc (less customer count) can be desc
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[],"_postman_id":"85ba0629-0eb5-400a-adba-a120dd3bd7f9"}],"id":"1d3f6fba-03a6-4377-859d-1f2b91636c0a","_postman_id":"1d3f6fba-03a6-4377-859d-1f2b91636c0a","description":""},{"name":"Division","item":[{"name":"Get All Division","id":"c1930de1-b554-456f-8ffc-f0cbc24f8ed8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{AdminToken}}"}],"url":"{{BaseUrl}}/api/v2/divisions?page=1&limit=10","urlObject":{"path":["api","v2","divisions"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"optional, default: 1
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"optional, max: 100, default: 10
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"c1930de1-b554-456f-8ffc-f0cbc24f8ed8"},{"name":"Create Division","id":"90b83323-ff18-4d44-869f-063dd5fc4ab4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{AdminToken}}"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"New","description":"name of the division
\n","type":"text"}]},"url":"{{BaseUrl}}/api/v2/divisions","urlObject":{"path":["api","v2","divisions"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"90b83323-ff18-4d44-869f-063dd5fc4ab4"},{"name":"Show Division","id":"f3449fbf-2494-4d3c-8dce-7e0c2c4abc2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{AdminToken}}"}],"url":"{{BaseUrl}}/api/v2/divisions/{{DivisionId}}","urlObject":{"path":["api","v2","divisions","{{DivisionId}}"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3449fbf-2494-4d3c-8dce-7e0c2c4abc2b"},{"name":"Update Division","id":"fa06ef43-434e-47ad-b922-201eaec8c49c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{AdminToken}}"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"New Name","type":"text"}]},"url":"{{BaseUrl}}/api/v2/divisions/{{DivisionId}}/update","urlObject":{"path":["api","v2","divisions","{{DivisionId}}","update"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa06ef43-434e-47ad-b922-201eaec8c49c"},{"name":"Set Division as Default","id":"bf7362ce-95ee-4d1f-898f-42a303c78854","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{AdminToken}}"}],"url":"{{BaseUrl}}/api/v2/divisions/{{DivisionId}}/set_default","urlObject":{"path":["api","v2","divisions","{{DivisionId}}","set_default"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf7362ce-95ee-4d1f-898f-42a303c78854"},{"name":"Delete Division","id":"dd9aa67c-cc36-4c95-bc65-227608be8b85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{AdminToken}}"}],"url":"{{BaseUrl}}/api/v2/divisions/{{DivisionId}}/delete","urlObject":{"path":["api","v2","divisions","{{DivisionId}}","delete"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd9aa67c-cc36-4c95-bc65-227608be8b85"}],"id":"09e83ff0-ecd1-4ed7-ad5a-b72022e81cf3","_postman_id":"09e83ff0-ecd1-4ed7-ad5a-b72022e81cf3","description":""},{"name":"Custom Channel","item":[{"name":"Send Message Text","id":"3da826a7-90ab-4fe4-a256-04fd6a444cd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"identifier_key\": \"paijem\",\n\t\"user_id\": \"johndoe@gmail.com\", \n\t\"name\": \"John Doe\",\n\t\"message\": \"Hi good morning\",\n\t\"type\": \"text\"\n}"},"url":"{{BaseUrl}}/{{AppCode}}/api/v2/custom_channel/send","description":"Sample Response
\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"Hi good morning\",\n \"payload\": {},\n \"timestamp\": \"2019-04-23T04:03:59Z\",\n \"type\": \"text\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"[file] https://www.solopos.com/assets/images/solopos.jpg [/file]\",\n \"payload\": {\n \"url\": \"https://www.solopos.com/assets/images/solopos.jpg\",\n \"caption\": \"Ini gambar siapa?\",\n \"file_name\": \"\",\n \"size\": 0,\n \"pages\": 1,\n \"encryption_key\": \"\"\n },\n \"timestamp\": \"2019-04-26T07:48:45Z\",\n \"type\": \"file_attachment\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"Hi good morning\",\n \"payload\": {\n \"text\": \"silahkan pencet\",\n \"buttons\": [\n {\n \"label\": \"button1\",\n \"postback_text\": \"\",\n \"type\": \"postback\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button1\",\n \"method\": \"get\",\n \"payload\": null\n }\n },\n {\n \"label\": \"button2\",\n \"postback_text\": \"\",\n \"type\": \"link\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button2?id=123\",\n \"method\": \"\",\n \"payload\": null\n }\n }\n ]\n },\n \"timestamp\": \"2019-04-26T07:58:40Z\",\n \"type\": \"buttons\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"choosen_agent\": null,\n \"room_id\": \"2270645\",\n \"message\": {\n \"message\": \"Hi good morning\",\n \"payload\": {\n \"cards\": [\n {\n \"image\": \"http://url.com/gambar.jpg\",\n \"title\": \"Atasan Blouse Tunik Wanita Baju Muslim Worie Longtop\",\n \"description\": \"Oleh sippnshop\\n96% (666 feedback)\\nRp 49.000.00,-\\nBUY 2 GET 1 FREE!!!\",\n \"default_action\": {\n \"type\": \"postback\",\n \"postback_text\": \"Load more\",\n \"payload\": {\n \"url\": \"http://url.com/baju?id=123&track_from_chat_room=123\",\n \"method\": \"get\",\n \"payload\": null\n }\n },\n \"buttons\": [\n {\n \"label\": \"button1\",\n \"postback_text\": \"Load more\",\n \"type\": \"postback\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button1\",\n \"method\": \"get\",\n \"payload\": null\n }\n },\n {\n \"label\": \"button2\",\n \"postback_text\": \"\",\n \"type\": \"link\",\n \"payload\": {\n \"url\": \"http://somewhere.com/button2?id=123\",\n \"method\": \"get\",\n \"payload\": null\n }\n }\n ]\n }\n ]\n },\n \"timestamp\": \"2019-04-26T08:10:25Z\",\n \"type\": \"carousel\",\n \"user\": {\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"extras\": {},\n \"user_id\": \"johndoe@gmail.com\",\n \"username\": \"John Doe\"\n }\n }\n }\n}\n{\n \"data\": {\n \"customer_room\": {\n \"channel_id\": 1,\n \"extras\": {\n \"additional_extras\": {\n \"a\": \"w\"\n },\n \"notes\": null,\n \"timezone_offset\": null,\n \"user_properties\": [\n {\n \"key\": \"aji\",\n \"value\": \"tra\"\n },\n {\n \"key\": \"ma\",\n \"value\": \"ta\"\n }\n ]\n },\n \"id\": 389,\n \"is_handled_by_bot\": true,\n \"is_resolved\": false,\n \"is_waiting\": false,\n \"last_comment_sender\": null,\n \"last_comment_sender_type\": null,\n \"last_comment_text\": null,\n \"last_comment_timestamp\": null,\n \"last_customer_timestamp\": null,\n \"name\": \"terlena\",\n \"room_badge\": null,\n \"room_id\": \"14059368\",\n \"source\": \"qiscus\",\n \"user_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"user_id\": \"terlena_saya\"\n },\n \"identity_token\": null,\n \"sdk_user\": {\n \"active\": true,\n \"app\": {\n \"code\": \"oni-bgo2lummmhvzqxbt5\",\n \"id\": 2987,\n \"id_str\": \"2987\",\n \"name\": \"oni\"\n },\n \"avatar\": {\n \"avatar\": {\n \"url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\"\n }\n },\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"email\": \"terlena_saya\",\n \"extras\": {\n \"additional_extras\": {\n \"teststs\": \"dadadadss\"\n },\n \"is_customer\": true,\n \"type\": \"customer\"\n },\n \"id\": 236723503,\n \"id_str\": \"236723503\",\n \"last_comment_id\": 0,\n \"last_comment_id_str\": \"0\",\n \"last_sync_event_id\": 0,\n \"pn_android_configured\": true,\n \"pn_ios_configured\": true,\n \"rtKey\": \"somestring\",\n \"token\": \"8O6iDT6ZUdy5OB5YkiOm1587357984\",\n \"username\": \"terlena\"\n }\n },\n \"status\": 200\n}\nCreate new customer session upon initiation
\n{\n \"data\": {\n \"customer_room\": {\n \"channel_id\": 1,\n \"extras\": {\n \"additional_extras\": {\n \"a\": \"w\"\n },\n \"notes\": null,\n \"timezone_offset\": null,\n \"user_properties\": [\n {\n \"key\": \"aji\",\n \"value\": \"tra\"\n },\n {\n \"key\": \"ma\",\n \"value\": \"ta\"\n }\n ]\n },\n \"id\": 389,\n \"is_handled_by_bot\": true,\n \"is_resolved\": false,\n \"is_waiting\": false,\n \"last_comment_sender\": null,\n \"last_comment_sender_type\": null,\n \"last_comment_text\": null,\n \"last_comment_timestamp\": null,\n \"last_customer_timestamp\": null,\n \"name\": \"terlena\",\n \"room_badge\": null,\n \"room_id\": \"14059368\",\n \"source\": \"qiscus\",\n \"user_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"user_id\": \"terlena_saya\"\n },\n \"identity_token\": null,\n \"sdk_user\": {\n \"active\": true,\n \"app\": {\n \"code\": \"oni-bgo2lummmhvzqxbt5\",\n \"id\": 2987,\n \"id_str\": \"2987\",\n \"name\": \"oni\"\n },\n \"avatar\": {\n \"avatar\": {\n \"url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\"\n }\n },\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"email\": \"terlena_saya\",\n \"extras\": {\n \"additional_extras\": {\n \"teststs\": \"dadadadss\"\n },\n \"is_customer\": true,\n \"type\": \"customer\"\n },\n \"id\": 236723503,\n \"id_str\": \"236723503\",\n \"last_comment_id\": 0,\n \"last_comment_id_str\": \"0\",\n \"last_sync_event_id\": 0,\n \"pn_android_configured\": true,\n \"pn_ios_configured\": true,\n \"rtKey\": \"somestring\",\n \"token\": \"8O6iDT6ZUdy5OB5YkiOm1587357984\",\n \"username\": \"terlena\"\n }\n },\n \"status\": 200\n}\nGet or update the existing customer session by using room_id and user_id
{\n \"data\": {\n \"customer_room\": {\n \"channel_id\": 1,\n \"extras\": {\n \"additional_extras\": {\n \"a\": \"w\"\n },\n \"notes\": null,\n \"timezone_offset\": null,\n \"user_properties\": [\n {\n \"key\": \"aji\",\n \"value\": \"tra\"\n },\n {\n \"key\": \"ma\",\n \"value\": \"ta\"\n }\n ]\n },\n \"id\": 389,\n \"is_handled_by_bot\": true,\n \"is_resolved\": false,\n \"is_waiting\": false,\n \"last_comment_sender\": null,\n \"last_comment_sender_type\": null,\n \"last_comment_text\": null,\n \"last_comment_timestamp\": null,\n \"last_customer_timestamp\": null,\n \"name\": \"terlena\",\n \"room_badge\": null,\n \"room_id\": \"14059368\",\n \"source\": \"qiscus\",\n \"user_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"user_id\": \"terlena_saya\"\n },\n \"identity_token\": null,\n \"sdk_user\": {\n \"active\": true,\n \"app\": {\n \"code\": \"oni-bgo2lummmhvzqxbt5\",\n \"id\": 2987,\n \"id_str\": \"2987\",\n \"name\": \"oni\"\n },\n \"avatar\": {\n \"avatar\": {\n \"url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\"\n }\n },\n \"avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"email\": \"terlena_saya\",\n \"extras\": {\n \"additional_extras\": {\n \"teststs\": \"dadadadss\"\n },\n \"is_customer\": true,\n \"type\": \"customer\"\n },\n \"id\": 236723503,\n \"id_str\": \"236723503\",\n \"last_comment_id\": 0,\n \"last_comment_id_str\": \"0\",\n \"last_sync_event_id\": 0,\n \"pn_android_configured\": true,\n \"pn_ios_configured\": true,\n \"rtKey\": \"somestring\",\n \"token\": \"8O6iDT6ZUdy5OB5YkiOm1587357984\",\n \"username\": \"terlena\"\n }\n },\n \"status\": 200\n}\nGet all unresolved session of a customer
\n{\n \"data\": {\n \"customer_rooms\": [\n {\n \"channel_id\": 1,\n \"id\": 392,\n \"is_handled_by_bot\": true,\n \"is_resolved\": false,\n \"is_waiting\": false,\n \"last_comment_sender\": null,\n \"last_comment_sender_type\": null,\n \"last_comment_text\": null,\n \"last_comment_timestamp\": \"2020-04-20T09:26:58Z\",\n \"last_customer_timestamp\": null,\n \"name\": \"terlena\",\n \"room_badge\": null,\n \"room_id\": \"14077598\",\n \"room_type\": \"individual\",\n \"source\": \"qiscus\",\n \"user_avatar_url\": \"https://d1edrlpyc25xu0.cloudfront.net/kiwari-prod/image/upload/wMWsDZP6ta/1516689726-ic_qiscus_client.png\",\n \"user_id\": \"terlena\"\n }\n ]\n },\n \"meta\": {\n \"current_total\": 1,\n \"cursor_after\": \"2020-04-20T03:54:10Z\",\n \"cursor_before\": \"2020-04-20T09:26:58Z\"\n },\n \"status\": 200\n}\nRetrieve list of your HSM Template for Broadcast registered in Qiscus Multichannel.
\napproved param should be set to true if you want to list only approved templates.
Sending WA HSM Template message.
\nYou must use HSM template that already registered and approved in Qiscus Multichannel.
\nphone_numbers can be filled up to 20 numbers.
hide_variables boolean, optional | if set true, value of variable will not shown in room
List of WA Broadcast API using HSM templates
\n","_postman_id":"c217fef3-0429-48f6-ae16-c27022f59d98"}],"event":[{"listen":"prerequest","script":{"id":"29d0ab16-a211-4e02-8ff4-40432abdae31","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94559a6d-a271-4ccf-aa8a-3b6799a21b7f","type":"text/javascript","exec":[""]}}]}