Webex · Example Payload

Webex List Contacts Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex List Contacts Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "List Contacts",
  "method": "GET",
  "path": "/contacts/organizations/{orgId}/contacts/search",
  "summary": "List Contacts",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "result": [
          {
            "schemas": "urn:cisco:codev:identity:contact:core:1.0",
            "meta": {
              "created": "2023-05-11T01:59:38.398Z",
              "lastModified": "2023-05-11T01:59:38.398Z"
            },
            "contactId": "441d0fa5-7fa0-491e-b27a-f017896c0bab",
            "firstName": "Simic",
            "lastName": "Zhang",
            "companyName": "Cisco Systems",
            "title": "Product Manager",
            "address": "{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}",
            "avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
            "displayName": "Logan",
            "addressInfo": {
              "city": "Milpitas",
              "country": "US",
              "street": "1099 Bird Ave.",
              "zipCode": "99212"
            },
            "primaryContactMethod": "EMAIL",
            "phoneNumbers": [
              {
                "type": "work",
                "value": "20134319"
              }
            ],
            "emails": [
              {
                "type": "work",
                "value": "simizhan@example.com"
              }
            ],
            "sipAddresses": [
              {
                "type": "work",
                "value": "sip://mysip1231233"
              }
            ],
            "ims": [
              {
                "type": "work",
                "value": "87003922"
              }
            ],
            "source": "CH",
            "isMigration": false,
            "orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9",
            "groupIds": [
              "b3e594aa-19ea-488a-9d42-f811e272f4bd"
            ]
          }
        ],
        "start": 0,
        "limit": 1000,
        "total": 1
      }
    }
  ]
}