User

User represents an Application end user who is engaging in a conversation with your organization.

People can discover and enter a conversation with you from multiple channels and, when registering, the user is assigned a unique key.

Communication can be started in different ways from various channels:

In order to retrieve User data, the Application must first be created on the Infobip’s platform and Integration has to be added.

User key

User key is used as a recipient address when sending messages over API.

Available methods

Get users

This method is used for getting application users.

https://api.infobip.com/omnichat/1/applications/{applicationKey}/users

Path parameters

Parameter Type Default value Description
applicationKey string - Application key.

Query parameters

Parameter Type Default value Description
limit integer 10000 Number of users in the response. Max is 10000.

Response

It can contain 5 fields, depending on available user data. Key and integrationType are obligatory, firstName, lastName and username are optional, depending on the integration and available user data.

Request example

GET /omnichat/1/applications/8F0792F86035A9F4290821F1EE6BC06A/users HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==	
  

Response example

[
    {
        "key": "A39311A5543180632DF25F8CE63BD21C28C12E83BC83D449BC4A9F32F1AE3C3E",
        "integrationType": "FACEBOOK"
    },
    {
        "key": "24F8599DF1A67F0DDF4BC67CC3D9AF8028C12E83BC83D449BC4A9F32F1AE3C3E",
        "integrationType": "FACEBOOK",
        "firstName": "firstName",
        "lastName": "lastName"
    },
    {
        "key": "7E705E15013B7576976160386C42F61E",
        "integrationType": "TELEGRAM",
        "firstName": "firstName"
    },
    {
        "key": "986ABBBD989A7430A27439B955F2AEDA",
        "integrationType": "TELEGRAM",
        "firstName": "firstName",
    		"lastName": "lastName"
      	"username": "username"
    },
    {
        "key": "1238D9066C9A56D7A0303FDC8EC445BE904AFA23640426BDAC683138851A7C3C",
        "integrationType": "VIBER",
        "username": "Username"
    },
    {
        "key": "3DF1D5E29A99F1BBB9C344F3B0E635FBDDA7F8B33417374ACC02F5265527E6",
        "integrationType": "LINE",
        "username": "Username"
    }
]