Chilkat Online Tools

C / Support API / List Support Addresses

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *email;
    const char *brand_id;
    const char *cname_status;
    const char *created_at;
    const char *default;
    const char *dns_results;
    const char *domain_verification_code;
    const char *domain_verification_status;
    const char *forwarding_status;
    const char *id;
    const char *name;
    const char *spf_status;
    const char *updated_at;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"login");
    CkHttp_putPassword(http,"password");

    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/recipient_addresses",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"recipient_addresses");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        email = CkJsonObject_stringOf(jResp,"recipient_addresses[i].email");
        brand_id = CkJsonObject_stringOf(jResp,"recipient_addresses[i].brand_id");
        cname_status = CkJsonObject_stringOf(jResp,"recipient_addresses[i].cname_status");
        created_at = CkJsonObject_stringOf(jResp,"recipient_addresses[i].created_at");
        default = CkJsonObject_stringOf(jResp,"recipient_addresses[i].default");
        dns_results = CkJsonObject_stringOf(jResp,"recipient_addresses[i].dns_results");
        domain_verification_code = CkJsonObject_stringOf(jResp,"recipient_addresses[i].domain_verification_code");
        domain_verification_status = CkJsonObject_stringOf(jResp,"recipient_addresses[i].domain_verification_status");
        forwarding_status = CkJsonObject_stringOf(jResp,"recipient_addresses[i].forwarding_status");
        id = CkJsonObject_stringOf(jResp,"recipient_addresses[i].id");
        name = CkJsonObject_stringOf(jResp,"recipient_addresses[i].name");
        spf_status = CkJsonObject_stringOf(jResp,"recipient_addresses[i].spf_status");
        updated_at = CkJsonObject_stringOf(jResp,"recipient_addresses[i].updated_at");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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