Chilkat Online Tools

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

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

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

resp := http.QuickRequest('POST','https://example.zendesk.com/api/v2/channels/voice/agents/:agent_id/users/:user_id/display');
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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>"
    }
  ]
}