In order to integrate with this API you will require an API key.
\nOnce you have an API key, simply send all your request with the header 'X-Authorization-Token' with the value of your API key.
\nAll requests in this API consume and produce JSON data.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2281947","collectionId":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","publishedId":"TzCHAV8b","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"9179f1"},"publishDate":"2021-03-24T15:06:10.000Z"},"item":[{"name":"Campaigns","item":[{"name":"List Campaigns","id":"13d19b41-c2b6-482f-acfc-efce0b4cb03e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.apexvisibility.co/api/campaign/list","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}},"urlObject":{"path":["api","campaign","list"],"host":["https://app.apexvisibility.co"],"query":[],"variable":[]}},"response":[],"_postman_id":"13d19b41-c2b6-482f-acfc-efce0b4cb03e"}],"id":"3851512c-ded9-4ddb-b7f9-0fa55c212079","_postman_id":"3851512c-ded9-4ddb-b7f9-0fa55c212079","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}}},{"name":"Menus","item":[{"name":"List Menus","id":"79b1d726-6ac0-48f8-83b0-51120e2a3153","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app.apexvisibility.co/api/menu?max=10&offset=0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}},"urlObject":{"path":["api","menu"],"host":["https://app.apexvisibility.co"],"query":[{"key":"max","value":"10"},{"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"79b1d726-6ac0-48f8-83b0-51120e2a3153"},{"name":"List Pages","id":"9139420f-93b0-4408-8c66-7bc2722b9dbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Cookie","type":"text","value":"{{prizecloudCookie}}"}],"url":"https://app.apexvisibility.co/api/menu/page?menuId=1124","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}},"urlObject":{"path":["api","menu","page"],"host":["https://app.apexvisibility.co"],"query":[{"key":"menuId","value":"1124"}],"variable":[]}},"response":[],"_postman_id":"9139420f-93b0-4408-8c66-7bc2722b9dbe"}],"id":"5ec5acdf-aab7-4450-8b31-fc473e3f3d1b","_postman_id":"5ec5acdf-aab7-4450-8b31-fc473e3f3d1b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}}},{"name":"Outbound Messaging","item":[{"name":"Send Session Message","id":"8c2d7e8f-6d24-4dd1-8e72-a5385c49150c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\"pageName\": \"Welcome\"}","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/:sessionId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}},"urlObject":{"path":["api","message",":sessionId"],"host":["https://app.apexvisibility.co"],"query":[],"variable":[{"id":"bf3dee60-34c4-4360-b493-1aab2d9f71bc","type":"any","value":"19187192","key":"sessionId"}]}},"response":[],"_postman_id":"8c2d7e8f-6d24-4dd1-8e72-a5385c49150c"},{"name":"Send WhatsApp Message","id":"0aebe0db-9e3f-4c6e-8266-8c16faa1fa45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp","urlObject":{"path":["api","message","whatsapp"],"host":["https://app.apexvisibility.co"],"query":[],"variable":[]}},"response":[{"id":"82bf2dd0-5650-466e-93fe-975b3de0ce89","name":"Send Message (Text with Image)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\",\n \"attachment\":{\n \"type\":\"IMAGE\",\n \"url\":\"https://www.dropbox.com/s/gftstv1o1tkf3yf/apex-white-circle.png\",\n \"name\":\"Logo\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"},{"id":"fddbd1af-b652-4ecd-be36-c97f12271deb","name":"Send Message (Text only)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"},{"id":"3034ec6b-f367-4509-924f-87a8e5a1500e","name":"Send Message (Text and Template + Image)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\",\n \"template\":\"5bbd2c5f_cbef_49db_bda1_fc9819a58d07:waba_mainmenu_update\",\n \"attachment\":{\n \"type\":\"IMAGE\",\n \"url\":\"https://www.dropbox.com/s/gftstv1o1tkf3yf/apex-white-circle.png\",\n \"name\":\"Logo\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"},{"id":"72dda1d9-d30f-4744-b3cb-7fc8db2802d5","name":"Send Message (Text and Template + Parameters)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\",\n \"template\":\"5bbd2c5f_cbef_49db_bda1_fc9819a58d07:waba_mainmenu_update\",\n \"attachment\":{\n \"type\":\"IMAGE\",\n \"url\":\"https://www.dropbox.com/s/gftstv1o1tkf3yf/apex-white-circle.png\",\n \"name\":\"Logo\"\n },\n \"parameters\": {\n \"1\": \"Hello\",\n \"2\": \"World\",\n \"button://0\": \"url://url-suffix-here.pdf\",\n \"button://1\": \"url://some-other-button.html\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"},{"id":"a357df0c-b035-4a03-a5a1-c6782434fd20","name":"Send Message (Text and Template + Video)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\",\n \"template\":\"5bbd2c5f_cbef_49db_bda1_fc9819a58d07:waba_mainmenu_update\",\n \"attachment\":{\n \"type\":\"VIDEO\",\n \"url\":\"https://www.dropbox.com/s/gftstv1o1tkf3yf/apex.mp4\",\n \"name\":\"Logo\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"},{"id":"85903dfe-7a23-420d-9620-1de63abff109","name":"Send Message (Text and Template + File)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\",\n \"template\":\"5bbd2c5f_cbef_49db_bda1_fc9819a58d07:waba_mainmenu_update\",\n \"attachment\":{\n \"type\":\"FILE\",\n \"url\":\"https://www.dropbox.com/s/gftstv1o1tkf3yf/apex.pdf\",\n \"name\":\"Logo\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"},{"id":"153be4a9-9cf2-4c5f-ae0c-770af6102f8e","name":"Send Message (Text and Template + Location)","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sender\":\"27782376683\",\n \"receiver\":\"27832659217\",\n \"message\":\"Thanks for your interest in our service!\",\n \"template\":\"5bbd2c5f_cbef_49db_bda1_fc9819a58d07:waba_mainmenu_update\",\n \"attachment\":{\n \"type\":\"LOCATION\",\n \"latitude\": \"-33.918861\",\n \"longitude\": \"18.423300\",\n \"name\": \"Cape Town\",\n \"address\": \"10 Loop Street\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://app.apexvisibility.co/api/message/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Mar 2021 14:41:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Application-Context","value":"application:production:8080"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": 1,\n \"template\": 0,\n \"errors\": 0,\n \"account\": 5,\n \"date\": 1616596869568\n}"}],"_postman_id":"0aebe0db-9e3f-4c6e-8266-8c16faa1fa45"}],"id":"796aae47-7feb-46a8-b904-a7e127527e43","_postman_id":"796aae47-7feb-46a8-b904-a7e127527e43","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}}},{"name":"Inbound Messaging","item":[{"name":"User initiatied message","event":[{"listen":"test","script":{"exec":["/**"," * The POST request expects a status >= 200 && < 400 within 10 seconds."," * "," * A sample of the result expected in the response body is as follows"," * "," * Content-type: application/json is expected","**/","","/*","{"," \"end\": false, // This indicates whether the session should be closed (next time the user enters this will start a new session)"," \"response\": \"Thank you for your entry, please respond with your favourite colour.\", // This is the response displayed to the user"," \"metadata\": { // Any additional metadata that needs to be stored with the session for potential later use can be stored here, this is merged in with existing data"," \"entered\":\"true\""," }","};","*/","","var jsonData = JSON.parse(responseBody);","","tests[\"End key exists\"] = \"end\" in jsonData;","tests[\"Response key exists\"] = \"response\" in jsonData;",""],"type":"text/javascript","id":"1ceafe34-1a6e-475e-b466-ee3f6edc13a0"}}],"id":"2aeef242-d3a9-47b8-b634-748409e275db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"session\": 123123214,\n\t\"msisdn\": \"27831234567\",\n\t\"time\": 1571697629,\n\t\"channel\": {\n\t\t\"code\": \"WhatsApp\",\n\t\t\"id\": \"27113213211\"\n\t},\n\t\"campaign\": {\n\t\t\"id\": 123,\n\t\t\"name\": \"Back to School\"\n\t},\n\t\"menu\": {\n\t\t\"id\": 456,\n\t\t\"name\": \"Back to School Main Menu\"\n\t},\n\t\n\t\"enteredCode\": \"6000512321321\",\n\t\"responses\": {\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Smith\",\n\t\t\"favouriteColour\": \"Green\"\n\t},\n\t\"metadata\": {\n\t\t\"voucher\": \"1234325\"\n\t}\n}"},"url":"https://yoururl.com/receive/message","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}},"urlObject":{"protocol":"https","path":["receive","message"],"host":["yoururl","com"],"query":[],"variable":[]}},"response":[{"id":"9ad5ccaa-c4a4-4425-a756-2b1fcfc8fbc8","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"session\": 123123214,\n\t\"msisdn\": \"27831234567\",\n\t\"time\": 1571697629,\n\t\"channel\": {\n\t\t\"code\": \"WhatsApp\",\n\t\t\"id\": \"27113213211\"\n\t},\n\t\"campaign\": {\n\t\t\"id\": 123,\n\t\t\"name\": \"Back to School\"\n\t},\n\t\"menu\": {\n\t\t\"id\": 456,\n\t\t\"name\": \"Back to School Main Menu\"\n\t},\n\t\n\t\"enteredCode\": \"6000512321321\",\n\t\"responses\": {\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Smith\",\n\t\t\"favouriteColour\": \"Green\"\n\t},\n\t\"metadata\": {\n\t\t\"voucher\": \"1234325\"\n\t}\n}"},"url":"https://yoururl.com/receive/message"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"end\": false,\n \"response\": \"Thank you for your query, please see the below options for more ...\",\n \"metadata\": {\n \"foo\": \"bar\"\n },\n \"attachment\": {\n \"type\": \"IMAGE\",\n \"name\": \"Best-Friends.jpg\",\n \"url\": \"https://yourserver.com/friends.jpg\"\n },\n \"page\": null\n}"}],"_postman_id":"2aeef242-d3a9-47b8-b634-748409e275db"},{"name":"User initiatied message with comments","event":[{"listen":"test","script":{"exec":["/**"," * The POST request expects a status >= 200 && < 400 within 10 seconds."," * "," * A sample of the result expected in the response body is as follows"," * "," * Content-type: application/json is expected","**/","","{"," \"end\": false, // This indicates whether the session should be closed (next time the user enters this will start a new session)"," \"response\": \"Thank you for your entry, please respond with your favourite colour.\", // This is the response displayed to the user"," \"metadata\": { // Any additional metadata that needs to be stored with the session for potential later use can be stored here, this is merged in with existing data"," \"entered\":\"true\""," }","}"],"type":"text/javascript","id":"f113f9c2-5db5-4ad4-b29c-ac85870512dd"}}],"id":"4975e120-aeaa-4232-a4ef-331e5f7f4f3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"session\": 123123214 /* Unique identifier of the session */\n\t\"msisdn\": \"27831234567\", /* the number of the user */\n\t\"time\": 1571697629, /* UNIX timestamp of the request */\n\t\"channel\": {\n\t\t\"code\": \"WhatsApp\", /* WhatsApp, SMS, USSD */\n\t\t\"id\": \"27113213211\" /* Identifier, usually the phone number of the channel */\n\t},\n\t\"campaign\": {\n\t\t\"id\": 123, /* Unique Campaign Identifier */\n\t\t\"name\": \"Back to School\"\n\t},\n\t\"menu\": {\n\t\t\"id\": 456, /* Unique Menu Identifier */\n\t\t\"name\": \"Back to School Main Menu\"\n\t},\n\t\n\t\"enteredCode\": \"6000512321321\", /* If the user entered a code, eg: *120*6000512321321# */\n\t\"responses\": { /* These are all the responses collected on the user journey thus far */\n\t\t\"firstName\": \"John\", \n\t\t\"lastName\": \"Smith\",\n\t\t\"favouriteColour\": \"Green\"\n\t},\n\t\"metadata\": { /* Any metadata related to the session */\n\t\t\"voucher\": \"1234325\"\n\t}\n}"},"url":"https://yoururl.com/receive/message","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}},"urlObject":{"protocol":"https","path":["receive","message"],"host":["yoururl","com"],"query":[],"variable":[]}},"response":[{"id":"a8d64b67-d83e-4674-a2ea-c3a717b08921","name":"Response with comments","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"session\": 123123214 /* Unique identifier of the session */\n\t\"msisdn\": \"27831234567\", /* the number of the user */\n\t\"time\": 1571697629, /* UNIX timestamp of the request */\n\t\"channel\": {\n\t\t\"code\": \"WhatsApp\", /* WhatsApp, SMS, USSD */\n\t\t\"id\": \"27113213211\" /* Identifier, usually the phone number of the channel */\n\t},\n\t\"campaign\": {\n\t\t\"id\": 123, /* Unique Campaign Identifier */\n\t\t\"name\": \"Back to School\"\n\t},\n\t\"menu\": {\n\t\t\"id\": 456, /* Unique Menu Identifier */\n\t\t\"name\": \"Back to School Main Menu\"\n\t},\n\t\n\t\"enteredCode\": \"6000512321321\", /* If the user entered a code, eg: *120*6000512321321# */\n\t\"responses\": { /* These are all the responses collected on the user journey thus far */\n\t\t\"firstName\": \"John\", \n\t\t\"lastName\": \"Smith\",\n\t\t\"favouriteColour\": \"Green\"\n\t},\n\t\"metadata\": { /* Any metadata related to the session */\n\t\t\"voucher\": \"1234325\"\n\t}\n}"},"url":"https://yoururl.com/receive/message"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"end\": false, /* Whether to end the session */\n \"response\": \"Thank you for your query, please see the below options for more ...\", /* The text response if any */\n \"metadata\": { /* Optional metadata to store with this session for your later use */\n \"foo\": \"bar\"\n },\n \"attachment\": { /* Optional attachment */\n \"type\": \"IMAGE\",\n \"name\": \"Best-Friends.jpg\",\n \"url\": \"https://yourserver.com/friends.jpg\"\n },\n \"page\": null /* Optional pre-defined page name if you wish to render that content rather */\n}"}],"_postman_id":"4975e120-aeaa-4232-a4ef-331e5f7f4f3a"}],"id":"09d9c70b-6c51-4fc7-8494-48200690604a","description":"The inbound messaging examples below are provided as a convenience for integrators.
\nThe URLs in these examples will be replaced with your chosen URLs and the data will be sent as a JSON post.
\nIn order to show users your custom response, we expect the response in JSON format as per the response examples. We have included a version with in line comments to better display what each parameter represents.
\n","_postman_id":"09d9c70b-6c51-4fc7-8494-48200690604a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]},"isInherited":true,"source":{"_postman_id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","id":"49c75a35-3f39-444f-9bad-bd4f2b9e81dc","name":"Apex API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Authorization-Token"},{"key":"value","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]}},"event":[{"listen":"prerequest","script":{"id":"a9838f68-dd90-4fba-875a-f0ea29eee4a2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a93c92f6-8c47-4367-aa99-ff2315b363bb","type":"text/javascript","exec":[""]}}],"variable":[{"key":"apexUrl","value":"https://app.apexvisibility.co"},{"key":"apiKey","value":"3z485khLPYvjmuhSZzJvK4P6c1D4Maa0jnrv818aDydwQyKcA68BW33HVIChBM7u"}]}