PureBasic / Support API / List Support Addresses
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/recipient_addresses",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
email.s
brand_id.s
cname_status.s
created_at.s
default.s
dns_results.s
domain_verification_code.s
domain_verification_status.s
forwarding_status.s
id.s
name.s
spf_status.s
updated_at.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"recipient_addresses")
While i < count_i
CkJsonObject::setCkI(jResp, i)
email = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].email")
brand_id = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].brand_id")
cname_status = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].cname_status")
created_at = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].created_at")
default = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].default")
dns_results = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].dns_results")
domain_verification_code = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].domain_verification_code")
domain_verification_status = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].domain_verification_status")
forwarding_status = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].forwarding_status")
id = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].id")
name = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].name")
spf_status = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].spf_status")
updated_at = CkJsonObject::ckStringOf(jResp,"recipient_addresses[i].updated_at")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
