{"_id":"5954c46ce06192001597a0b8","project":"54eb50e5615ffc1900305a16","version":{"_id":"54eb63b859b1172100334fae","project":"54eb50e5615ffc1900305a16","forked_from":"54eb63a1867e1917009b711d","__v":28,"createdAt":"2015-02-23T17:30:32.501Z","releaseDate":"2015-02-23T17:30:32.501Z","categories":["54eb63b959b1172100334faf","54eb63b959b1172100334fb0","54eb63b959b1172100334fb1","54eb63b959b1172100334fb2","54ed8dd4ab373e2300f50eae","54ed99b2ab373e2300f50ede","55153a6de68daa2f00cff838","551546edbc466623002afe72","5515472ac28d6125001b8884","55154749c28d6125001b8885","555d9b4106dfec0d00d38ea7","5613e06e433e5735007c7708","5624bbb785a31117001c5403","56669e857cc81e0d00253f8e","568b8d837a42220d00498311","56a632277ef6620d00e2f18a","56d8147c3eb4dd0b00201aac","57a9ce2fac6db30e000d7efd","57a9cf4e944ea60e00dc3f74","58172386715dce0f00da4aa0","582dc59ee1b8692300c0dd03","589b19b4fec2730f0082e040","58b04a023529383900a759b5","58b92d1598157a0f004869bf","592e7685c58275000f20174f","59392839e376d4002f8a0474","59393064e376d4002f8a05a1","5947ae0d4005e2000f3a4fec","594a74df1d1de5001ab3517a","5954bc387a147f001b918915","59b8eeeb707542001076d3b6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"5954bc387a147f001b918915","project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-29T08:37:12.853Z","from_sync":false,"order":7,"slug":"omni-chat","title":"OMNI Chat"},"user":"57a98d832242630e00cc8df7","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-29T09:12:12.507Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Want to use the endless possibilities of omnichannel communication and reach your customers on their preferred channel?\nThe first step is creating an application on Infobip's platform in order to use the **Omni Chat API**. Setup process starts with the application setup and continues with adding integrations for different channels you want to use.\n\nThe application represents a parent container for all integrations. Integration contains Chat channel information. For example, registering LINE channel on Infobip's platform is done by adding an integration with LINE data to the application.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1372c2e-application.png\",\n        \"application.png\",\n        315,\n        92,\n        \"#ded4d0\"\n      ],\n      \"caption\": \"Setup process\"\n    }\n  ]\n}\n[/block]\nOn this page, you will find the instructions on how to:\n\n* [Create a new Infobip application over API](#create-a-new-application)\n* [Update your Infobip application over API](#update-application)\n* [Retrieve your application over an API](#get-application)\n* [List all your applications over an API](#get-applications)\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Info\",\n  \"body\": \"After you finish with the application setup, you can continue with the integration setup.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"Create a new application\"\n}\n[/block]\nThis method allows you to create a new application. During the creation, you will be able to add a webhook on which you would like to receive messages from your users from various channels.\n\n```\nhttps://api.infobip.com/omnichat/1/applications\n```\n\n##Body parameters\n\n|Parameter|Type|Required|Description|\n|-|-|-|\n|name|string|Yes|Name of the application|\n|webhookUrl|string|Optional|Webhook url|\n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /omnichat/1/applications HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\\nContent-Type: application/json\\n\\n{\\n  \\\"name\\\":\\\"My first application\\\",\\n  \\\"webhookUrl\\\":\\\"http://www.myWebsite.com/chat/webhook\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"key\\\":\\\"0F3C3F29829FAB88714BA205BEC6D28F\\\",\\n  \\\"name\\\":\\\"My first application\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### Response format\nOn success, the response header HTTP status code will be `200 OK`. \nOn error, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without user’s authorization, you will receive a `401` Unauthorized error.\n\n|Parameter|Type|Description|\n|-|-|\n|key|string|Application key|\n|name|string|Name of the application|\n[block:api-header]\n{\n  \"title\": \"Update application\"\n}\n[/block]\nThis method allows you to update the existing application.\n\n```\nhttps://api.infobip.com/omnichat/1/applications/{applicationKey}\n```\n\n##Body parameters\n\n|Parameter|Type|Required|Description|\n|-|-|-|\n|name|string|Yes|Name of the application|\n|webhookUrl|string|Optional|Webhook url|\n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT /omnichat/1/applications/0F3C3F29829FAB88714BA205BEC6D28F HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\\nContent-Type: application/json\\n\\n{\\n  \\\"name\\\":\\\"My first application\\\",\\n  \\\"webhookUrl\\\":\\\"http://www.myWebsite.com/chat/webhook\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"key\\\":\\\"0F3C3F29829FAB88714BA205BEC6D28F\\\",\\n  \\\"name\\\":\\\"My first application\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### Response format\nIf successful, the response header HTTP status code will be `200 OK`. \nIf not, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without the user’s authorization, you will receive a `401` Unauthorized error.\n\n|Parameter|Type|Description|\n|-|-|\n|key|string|Application key|\n|name|string|Name of the application|\n[block:api-header]\n{\n  \"title\": \"Get application\"\n}\n[/block]\nUse this method to retrieve your application.\n\n```\nhttps://api.infobip.com/omnichat/1/applications/{applicationKey}\n```\n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /omnichat/1/applications/0F3C3F29829FAB88714BA205BEC6D28F HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"key\\\":\\\"0F3C3F29829FAB88714BA205BEC6D28F\\\",\\n  \\\"name\\\":\\\"My first application\\\",\\n  \\\"webhookUrl\\\":\\\"http://www.myWebsite.com/chat/webhook\\\",\\n  \\\"integrations\\\":{}\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### Response format\nIf  successful, the response header HTTP status code will be `200 OK`.\nIf not, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without the user’s authorization, you will receive a `401` Unauthorized error.\n\n|Parameter|Type|Description|\n|-|-|\n|key|string|Application key|\n|name|string|Name of the application|\n|integrations|Array|Array of Integrations|\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Get applications\"\n}\n[/block]\nUse this method to retrieve all of your applications\n\n```\nhttps://api.infobip.com/omnichat/1/applications\n```\n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /omnichat/1/applications HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"applications\\\": [\\n    {\\n      \\\"key\\\":\\\"0F3C3F29829FAB88714BA205BEC6D28F\\\",\\n      \\\"name\\\":\\\"My first application\\\",\\n      \\\"webhookUrl\\\":\\\"http://www.myWebsite.com/chat/webhook\\\",\\n      \\\"integrations\\\":{}\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nIf successful, the response header HTTP status code will be `200 OK`. \nIf not, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without user’s authorization, you will receive a `401` Unauthorized error.\n[block:api-header]\n{\n  \"title\": \"Get users\"\n}\n[/block]\nThis method is used for getting application users. \n\n```\nhttps://api.infobip.com/omnichat/1/applications/{applicationKey}/users\n```\n\n###Request example\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /omnichat/1/applications/8F0792F86035A9F4290821F1EE6BC06A/users HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Response example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n    {\\n        \\\"key\\\": \\\"A39311A5543180632DF25F8CE63BD21C28C12E83BC83D449BC4A9F32F1AE3C3E\\\",\\n        \\\"integrationType\\\": \\\"FACEBOOK\\\"\\n    },\\n    {\\n        \\\"key\\\": \\\"24F8599DF1A67F0DDF4BC67CC3D9AF8028C12E83BC83D449BC4A9F32F1AE3C3E\\\",\\n        \\\"integrationType\\\": \\\"FACEBOOK\\\",\\n        \\\"firstName\\\": \\\"firstName\\\",\\n        \\\"lastName\\\": \\\"lastName\\\"\\n    },\\n    {\\n        \\\"key\\\": \\\"7E705E15013B7576976160386C42F61E\\\",\\n        \\\"integrationType\\\": \\\"TELEGRAM\\\",\\n        \\\"firstName\\\": \\\"firstName\\\"\\n    },\\n    {\\n        \\\"key\\\": \\\"986ABBBD989A7430A27439B955F2AEDA\\\",\\n        \\\"integrationType\\\": \\\"TELEGRAM\\\",\\n        \\\"firstName\\\": \\\"firstName\\\",\\n    \\t\\t\\\"lastName\\\": \\\"lastName\\\",\\n      \\t\\\"username\\\": \\\"username\\\"\\n    },\\n    {\\n        \\\"key\\\": \\\"1238D9066C9A56D7A0303FDC8EC445BE904AFA23640426BDAC683138851A7C3C\\\",\\n        \\\"integrationType\\\": \\\"VIBER\\\",\\n        \\\"username\\\": \\\"Username\\\"\\n    },\\n    {\\n        \\\"key\\\": \\\"3DF1D5E29A99F1BBB9C344F3B0E635FBDDA7F8B33417374ACC02F5265527E6\\\",\\n        \\\"integrationType\\\": \\\"LINE\\\",\\n        \\\"username\\\": \\\"Username\\\"\\n    }\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Manage the Omni Chat application on Infobip platform.","slug":"omni-chat-application","type":"basic","title":"Application"}

Application

Manage the Omni Chat application on Infobip platform.

Want to use the endless possibilities of omnichannel communication and reach your customers on their preferred channel? The first step is creating an application on Infobip's platform in order to use the **Omni Chat API**. Setup process starts with the application setup and continues with adding integrations for different channels you want to use. The application represents a parent container for all integrations. Integration contains Chat channel information. For example, registering LINE channel on Infobip's platform is done by adding an integration with LINE data to the application. [block:image] { "images": [ { "image": [ "https://files.readme.io/1372c2e-application.png", "application.png", 315, 92, "#ded4d0" ], "caption": "Setup process" } ] } [/block] On this page, you will find the instructions on how to: * [Create a new Infobip application over API](#create-a-new-application) * [Update your Infobip application over API](#update-application) * [Retrieve your application over an API](#get-application) * [List all your applications over an API](#get-applications) [block:callout] { "type": "info", "title": "Info", "body": "After you finish with the application setup, you can continue with the integration setup." } [/block] [block:api-header] { "type": "post", "title": "Create a new application" } [/block] This method allows you to create a new application. During the creation, you will be able to add a webhook on which you would like to receive messages from your users from various channels. ``` https://api.infobip.com/omnichat/1/applications ``` ##Body parameters |Parameter|Type|Required|Description| |-|-|-| |name|string|Yes|Name of the application| |webhookUrl|string|Optional|Webhook url| ###Request example [block:code] { "codes": [ { "code": "POST /omnichat/1/applications HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json\n\n{\n \"name\":\"My first application\",\n \"webhookUrl\":\"http://www.myWebsite.com/chat/webhook\"\n}", "language": "json" } ] } [/block] ###Response [block:code] { "codes": [ { "code": "{\n \"key\":\"0F3C3F29829FAB88714BA205BEC6D28F\",\n \"name\":\"My first application\"\n}", "language": "json" } ] } [/block] ### Response format On success, the response header HTTP status code will be `200 OK`. On error, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without user’s authorization, you will receive a `401` Unauthorized error. |Parameter|Type|Description| |-|-| |key|string|Application key| |name|string|Name of the application| [block:api-header] { "title": "Update application" } [/block] This method allows you to update the existing application. ``` https://api.infobip.com/omnichat/1/applications/{applicationKey} ``` ##Body parameters |Parameter|Type|Required|Description| |-|-|-| |name|string|Yes|Name of the application| |webhookUrl|string|Optional|Webhook url| ###Request example [block:code] { "codes": [ { "code": "PUT /omnichat/1/applications/0F3C3F29829FAB88714BA205BEC6D28F HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json\n\n{\n \"name\":\"My first application\",\n \"webhookUrl\":\"http://www.myWebsite.com/chat/webhook\"\n}", "language": "json" } ] } [/block] ###Response [block:code] { "codes": [ { "code": "{\n \"key\":\"0F3C3F29829FAB88714BA205BEC6D28F\",\n \"name\":\"My first application\"\n}", "language": "json" } ] } [/block] ### Response format If successful, the response header HTTP status code will be `200 OK`. If not, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without the user’s authorization, you will receive a `401` Unauthorized error. |Parameter|Type|Description| |-|-| |key|string|Application key| |name|string|Name of the application| [block:api-header] { "title": "Get application" } [/block] Use this method to retrieve your application. ``` https://api.infobip.com/omnichat/1/applications/{applicationKey} ``` ###Request example [block:code] { "codes": [ { "code": "GET /omnichat/1/applications/0F3C3F29829FAB88714BA205BEC6D28F HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", "language": "json" } ] } [/block] ###Response [block:code] { "codes": [ { "code": "{\n \"key\":\"0F3C3F29829FAB88714BA205BEC6D28F\",\n \"name\":\"My first application\",\n \"webhookUrl\":\"http://www.myWebsite.com/chat/webhook\",\n \"integrations\":{}\n}", "language": "json" } ] } [/block] ### Response format If successful, the response header HTTP status code will be `200 OK`. If not, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without the user’s authorization, you will receive a `401` Unauthorized error. |Parameter|Type|Description| |-|-| |key|string|Application key| |name|string|Name of the application| |integrations|Array|Array of Integrations| [block:api-header] { "type": "get", "title": "Get applications" } [/block] Use this method to retrieve all of your applications ``` https://api.infobip.com/omnichat/1/applications ``` ###Request example [block:code] { "codes": [ { "code": "GET /omnichat/1/applications HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", "language": "json" } ] } [/block] ###Response [block:code] { "codes": [ { "code": "{\n \"applications\": [\n {\n \"key\":\"0F3C3F29829FAB88714BA205BEC6D28F\",\n \"name\":\"My first application\",\n \"webhookUrl\":\"http://www.myWebsite.com/chat/webhook\",\n \"integrations\":{}\n }\n ]\n}", "language": "json" } ] } [/block] If successful, the response header HTTP status code will be `200 OK`. If not, you will receive an [error response status code](/docs/response-codes#section-chat-error-codes). If you try to create an application without user’s authorization, you will receive a `401` Unauthorized error. [block:api-header] { "title": "Get users" } [/block] This method is used for getting application users. ``` https://api.infobip.com/omnichat/1/applications/{applicationKey}/users ``` ###Request example [block:code] { "codes": [ { "code": "GET /omnichat/1/applications/8F0792F86035A9F4290821F1EE6BC06A/users HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", "language": "json" } ] } [/block] ###Response example [block:code] { "codes": [ { "code": "[\n {\n \"key\": \"A39311A5543180632DF25F8CE63BD21C28C12E83BC83D449BC4A9F32F1AE3C3E\",\n \"integrationType\": \"FACEBOOK\"\n },\n {\n \"key\": \"24F8599DF1A67F0DDF4BC67CC3D9AF8028C12E83BC83D449BC4A9F32F1AE3C3E\",\n \"integrationType\": \"FACEBOOK\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\"\n },\n {\n \"key\": \"7E705E15013B7576976160386C42F61E\",\n \"integrationType\": \"TELEGRAM\",\n \"firstName\": \"firstName\"\n },\n {\n \"key\": \"986ABBBD989A7430A27439B955F2AEDA\",\n \"integrationType\": \"TELEGRAM\",\n \"firstName\": \"firstName\",\n \t\t\"lastName\": \"lastName\",\n \t\"username\": \"username\"\n },\n {\n \"key\": \"1238D9066C9A56D7A0303FDC8EC445BE904AFA23640426BDAC683138851A7C3C\",\n \"integrationType\": \"VIBER\",\n \"username\": \"Username\"\n },\n {\n \"key\": \"3DF1D5E29A99F1BBB9C344F3B0E635FBDDA7F8B33417374ACC02F5265527E6\",\n \"integrationType\": \"LINE\",\n \"username\": \"Username\"\n }\n]", "language": "json" } ] } [/block]