Chilkat Online Tools

Java / Support API / Open a User's Profile in an Agent's Browser

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/channels/voice/agents/:agent_id/users/:user_id/display");
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }
  }
}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/channels/voice/agents/:agent_id/users/:user_id/display

Postman Collection Item JSON

{
  "name": "Open a User's Profile in an Agent's Browser",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/users/:user_id/display",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "channels",
        "voice",
        "agents",
        ":agent_id",
        "users",
        ":user_id",
        "display"
      ],
      "variable": [
        {
          "key": "agent_id",
          "value": "<integer>"
        },
        {
          "key": "user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Allows you to instruct an agent's browser to open a user's profile.\n\nWhen the message is successfully delivered to an agent's browser:\n\n```http\nStatus: 200 OK\n```\n\nWhen `agent_id` or `ticket_id` is invalid:\n\n```http\nStatus: 404 Not Found\n```\n\n#### Allowed For\n* Agents"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/users/:user_id/display",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "channels",
            "voice",
            "agents",
            ":agent_id",
            "users",
            ":user_id",
            "display"
          ],
          "variable": [
            {
              "key": "agent_id"
            },
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "<string>"
    },
    {
      "name": "When the `agent_id` or `user_id` is invalid",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/users/:user_id/display",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "channels",
            "voice",
            "agents",
            ":agent_id",
            "users",
            ":user_id",
            "display"
          ],
          "variable": [
            {
              "key": "agent_id"
            },
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "<string>"
    }
  ]
}