unicodeCpp / Support API / List Support Addresses
Back to Collection Items
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"password");
http.SetRequestHeader(L"Accept",L"application/json");
CkStringBuilderW sbResponseBody;
success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/recipient_addresses",sbResponseBody);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = http.get_LastStatus();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",http.lastHeader());
wprintf(L"Failed.\n");
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.
const wchar_t *email = 0;
const wchar_t *brand_id = 0;
const wchar_t *cname_status = 0;
const wchar_t *created_at = 0;
const wchar_t *default = 0;
const wchar_t *dns_results = 0;
const wchar_t *domain_verification_code = 0;
const wchar_t *domain_verification_status = 0;
const wchar_t *forwarding_status = 0;
const wchar_t *id = 0;
const wchar_t *name = 0;
const wchar_t *spf_status = 0;
const wchar_t *updated_at = 0;
int i = 0;
int count_i = jResp.SizeOfArray(L"recipient_addresses");
while (i < count_i) {
jResp.put_I(i);
email = jResp.stringOf(L"recipient_addresses[i].email");
brand_id = jResp.stringOf(L"recipient_addresses[i].brand_id");
cname_status = jResp.stringOf(L"recipient_addresses[i].cname_status");
created_at = jResp.stringOf(L"recipient_addresses[i].created_at");
default = jResp.stringOf(L"recipient_addresses[i].default");
dns_results = jResp.stringOf(L"recipient_addresses[i].dns_results");
domain_verification_code = jResp.stringOf(L"recipient_addresses[i].domain_verification_code");
domain_verification_status = jResp.stringOf(L"recipient_addresses[i].domain_verification_status");
forwarding_status = jResp.stringOf(L"recipient_addresses[i].forwarding_status");
id = jResp.stringOf(L"recipient_addresses[i].id");
name = jResp.stringOf(L"recipient_addresses[i].name");
spf_status = jResp.stringOf(L"recipient_addresses[i].spf_status");
updated_at = jResp.stringOf(L"recipient_addresses[i].updated_at");
i = i + 1;
}
}
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}"
}
]
}
