Chilkat Online Tools

delphiAx / Support API / List Support Addresses

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
email: WideString;
brand_id: WideString;
cname_status: WideString;
created_at: WideString;
default: WideString;
dns_results: WideString;
domain_verification_code: WideString;
domain_verification_status: WideString;
forwarding_status: WideString;
id: WideString;
name: WideString;
spf_status: WideString;
updated_at: WideString;
i: Integer;
count_i: 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');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://example.zendesk.com/api/v2/recipient_addresses',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

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

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

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "recipient_addresses": [
//     {
//       "email": "<string>",
//       "brand_id": "<integer>",
//       "cname_status": "failed",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "dns_results": "failed",
//       "domain_verification_code": "<string>",
//       "domain_verification_status": "unknown",
//       "forwarding_status": "verified",
//       "id": "<integer>",
//       "name": "<string>",
//       "spf_status": "verified",
//       "updated_at": "<dateTime>"
//     },
//     {
//       "email": "<string>",
//       "brand_id": "<integer>",
//       "cname_status": "verified",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "dns_results": "failed",
//       "domain_verification_code": "<string>",
//       "domain_verification_status": "failed",
//       "forwarding_status": "verified",
//       "id": "<integer>",
//       "name": "<string>",
//       "spf_status": "verified",
//       "updated_at": "<dateTime>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i := 0;
count_i := jResp.SizeOfArray('recipient_addresses');
while i < count_i do
  begin
    jResp.I := i;
    email := jResp.StringOf('recipient_addresses[i].email');
    brand_id := jResp.StringOf('recipient_addresses[i].brand_id');
    cname_status := jResp.StringOf('recipient_addresses[i].cname_status');
    created_at := jResp.StringOf('recipient_addresses[i].created_at');
    default := jResp.StringOf('recipient_addresses[i].default');
    dns_results := jResp.StringOf('recipient_addresses[i].dns_results');
    domain_verification_code := jResp.StringOf('recipient_addresses[i].domain_verification_code');
    domain_verification_status := jResp.StringOf('recipient_addresses[i].domain_verification_status');
    forwarding_status := jResp.StringOf('recipient_addresses[i].forwarding_status');
    id := jResp.StringOf('recipient_addresses[i].id');
    name := jResp.StringOf('recipient_addresses[i].name');
    spf_status := jResp.StringOf('recipient_addresses[i].spf_status');
    updated_at := jResp.StringOf('recipient_addresses[i].updated_at');
    i := i + 1;
  end;

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/recipient_addresses

Postman Collection Item JSON

{
  "name": "List Support Addresses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/recipient_addresses",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "recipient_addresses"
      ]
    },
    "description": "Lists all the support addresses for the account.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Admins\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/recipient_addresses",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "recipient_addresses"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"recipient_addresses\": [\n    {\n      \"email\": \"<string>\",\n      \"brand_id\": \"<integer>\",\n      \"cname_status\": \"failed\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"dns_results\": \"failed\",\n      \"domain_verification_code\": \"<string>\",\n      \"domain_verification_status\": \"unknown\",\n      \"forwarding_status\": \"verified\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"spf_status\": \"verified\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"email\": \"<string>\",\n      \"brand_id\": \"<integer>\",\n      \"cname_status\": \"verified\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"dns_results\": \"failed\",\n      \"domain_verification_code\": \"<string>\",\n      \"domain_verification_status\": \"failed\",\n      \"forwarding_status\": \"verified\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"spf_status\": \"verified\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ]\n}"
    }
  ]
}