- About this guide
- Architecture: BEMS-Connect
- What are instant messaging APIs?
- Instant messaging methods
- METHOD_AcceptChat
- METHOD_AcceptFileXfer
- METHOD_AddContact
- METHOD_AddGroup
- METHOD_BeginSession
- METHOD_BlockContact
- METHOD_CopyContactToGroup
- METHOD_DeclineChat
- METHOD_DeclineFileXfer
- METHOD_EndChat
- METHOD_GetAuthenticationInfo
- METHOD_GetContactDetail
- METHOD_GetContactList
- METHOD_GetContactPhotos
- METHOD_GetContactsState
- METHOD_InviteFileXfer
- METHOD_MessageAck
- METHOD_MoveContact
- METHOD_NotifyBackground
- METHOD_Ping
- METHOD_ReceiveFile
- METHOD_RegisterTempRemotePresence
- METHOD_RemoveContact
- METHOD_RemoveContactFromGroup
- METHOD_RemoveGroup
- METHOD_RenameGroup
- METHOD_ScheduleNotification
- METHOD_SearchDirectory
- METHOD_SendFile
- METHOD_SendMessage
- METHOD_SetGDAuthToken
- METHOD_SetGDToken
- METHOD_SetGNPToken
- METHOD_SetOAuth2Token
- METHOD_SetPersonalMessage
- METHOD_SetPresence
- METHOD_StartChat
- METHOD_StartTyping
- METHOD_StopTyping
- METHOD_System.GetServerInfo
- METHOD_TerminateSession
- METHOD_UnblockContact
- METHOD_UnRegisterTempRemotePresence
- METHOD_UserUpdate
- Adminstrative methods
- User methods
- Event notifications
- HTTP response codes
Prerequisites
To use the persistent chat APIs, the following prerequisites must be met:
- The persistent chat feature must be enabled in theMicrosoft Lync Server2013 orSkype for Business. Refer to yourSkype for BusinessorMicrosoft Lync Serverdocumentation for instructions.
- Users must be enabled for persistent chat onBEMS. For instructions, see theAdministration content.BlackBerry Connect
- UCMA SDK version 4.0 or later must be installed on the computer hosting theBEMS-Connectservice to correspond to connections toMicrosoft Lync Server2013 orSkype for Business.
- X-GC-VERSION http header value is set to 2.5.0.0 or later in the API calls. This is the minimum client version where persistent chat related features are enabled on theConnectservice.