Chilkat Online Tools

autoit / Support API / List Support Addresses

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/recipient_addresses",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sEmail
Local $sBrand_id
Local $sCname_status
Local $sCreated_at
Local $sDefault
Local $sDns_results
Local $sDomain_verification_code
Local $sDomain_verification_status
Local $sForwarding_status
Local $sId
Local $sName
Local $spf_status
Local $sUpdated_at

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("recipient_addresses")
While $i < $iCount_i
    $oJResp.I = $i
    $sEmail = $oJResp.StringOf("recipient_addresses[i].email")
    $sBrand_id = $oJResp.StringOf("recipient_addresses[i].brand_id")
    $sCname_status = $oJResp.StringOf("recipient_addresses[i].cname_status")
    $sCreated_at = $oJResp.StringOf("recipient_addresses[i].created_at")
    $sDefault = $oJResp.StringOf("recipient_addresses[i].default")
    $sDns_results = $oJResp.StringOf("recipient_addresses[i].dns_results")
    $sDomain_verification_code = $oJResp.StringOf("recipient_addresses[i].domain_verification_code")
    $sDomain_verification_status = $oJResp.StringOf("recipient_addresses[i].domain_verification_status")
    $sForwarding_status = $oJResp.StringOf("recipient_addresses[i].forwarding_status")
    $sId = $oJResp.StringOf("recipient_addresses[i].id")
    $sName = $oJResp.StringOf("recipient_addresses[i].name")
    $spf_status = $oJResp.StringOf("recipient_addresses[i].spf_status")
    $sUpdated_at = $oJResp.StringOf("recipient_addresses[i].updated_at")
    $i = $i + 1
Wend

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