Webex · Example Payload

Webex Create A Contact Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Create A Contact 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": "Create a Contact",
  "method": "POST",
  "path": "/contacts/organizations/{orgId}/contacts",
  "summary": "Create a Contact",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "schemas": "urn:cisco:codev:identity:contact:core:1.0",
        "displayName": "John Andersen",
        "firstName": "John",
        "lastName": "Andersen",
        "companyName": "Cisco Systems",
        "title": "GM",
        "address": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
        "avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
        "primaryContactMethod": "SIPADDRESS",
        "source": "Webex4Broadworks",
        "emails": [
          {
            "value": "user1@example.home.com",
            "type": "home",
            "primary": false
          }
        ],
        "phoneNumbers": [
          {
            "value": "400 123 1234",
            "type": "work",
            "primary": true
          }
        ],
        "sipAddresses": [
          {
            "value": "sipAddress value1",
            "type": "enterprise",
            "primary": true
          }
        ],
        "ims": [
          {
            "value": "aim_account_ID",
            "type": "aim",
            "primary": true
          }
        ],
        "groupIds": [
          "9ac175bf-0249-4287-8fb3-e320e525fcf6"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "schemas": "urn:cisco:codev:identity:contact:core:1.0",
        "meta": {
          "created": "2023-05-10T09:24:44.910Z",
          "lastModified": "2023-05-10T09:24:44.910Z"
        },
        "contactId": "933de120-ad46-49b0-91cc-65c3966bb14e",
        "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": "153ced48-d2d1-4369-86fd-9b9fade218ff",
        "groupIds": [
          "b3e594aa-19ea-488a-9d42-f811e272f4bd"
        ]
      }
    }
  ]
}