Jump to: navigation, search

IdentifyUCSContact

This operation is part of the UCS Integration with Voice API section of the Web Services API.

Overview

Returns the identity for the specified UCS contact.

Request URL /api/v2/contacts/ucs
HTTP method POST
Required features One of the following, depending on the type of contact you want to identify:
  • api-ucs-voice
  • multimedia-*

Parameters

Parameter Value
operationName IdentifyUCSContact
emailAddress The email address to use for identification.
lastName The last name to use for identification.
phoneNumber The phone number to use for identification.
mediaType The type of media for which to search.
createContactEnabled Specify "false" to only look up a contact, or specify "true" for the operation to also create a contact if a contact is not found.
userData The attached data to use for identification.

Sample

Request

POST api/v2/contacts/ucs
{
  "operationName": "IdentifyUCSContact",
  "phoneNumber":"323-234-2342",
  "mediaType":"call",
  "userData":{"key1":"value1","key2":"value2"}
}

HTTP response

{
  "statusCode": 0,
  "referenceId": 123
}

CometD notifications

Success

{
 "referenceId": 123,
 "contactId": "0000DaA3G4VF000Q"
}

Error

{
 "referenceId": 123,
 "errorMessage": "UCS request failed"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on January 27, 2017, at 11:02.