TCL / Support API / List Support Addresses
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/recipient_addresses" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "recipient_addresses"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set email [CkJsonObject_stringOf $jResp "recipient_addresses[i].email"]
set brand_id [CkJsonObject_stringOf $jResp "recipient_addresses[i].brand_id"]
set cname_status [CkJsonObject_stringOf $jResp "recipient_addresses[i].cname_status"]
set created_at [CkJsonObject_stringOf $jResp "recipient_addresses[i].created_at"]
set default [CkJsonObject_stringOf $jResp "recipient_addresses[i].default"]
set dns_results [CkJsonObject_stringOf $jResp "recipient_addresses[i].dns_results"]
set domain_verification_code [CkJsonObject_stringOf $jResp "recipient_addresses[i].domain_verification_code"]
set domain_verification_status [CkJsonObject_stringOf $jResp "recipient_addresses[i].domain_verification_status"]
set forwarding_status [CkJsonObject_stringOf $jResp "recipient_addresses[i].forwarding_status"]
set id [CkJsonObject_stringOf $jResp "recipient_addresses[i].id"]
set name [CkJsonObject_stringOf $jResp "recipient_addresses[i].name"]
set spf_status [CkJsonObject_stringOf $jResp "recipient_addresses[i].spf_status"]
set updated_at [CkJsonObject_stringOf $jResp "recipient_addresses[i].updated_at"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
}
]
}