SQL Server / Support API / List Support Addresses
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/recipient_addresses', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @email nvarchar(4000)
DECLARE @brand_id nvarchar(4000)
DECLARE @cname_status nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @default nvarchar(4000)
DECLARE @dns_results nvarchar(4000)
DECLARE @domain_verification_code nvarchar(4000)
DECLARE @domain_verification_status nvarchar(4000)
DECLARE @forwarding_status nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @spf_status nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'recipient_addresses'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'recipient_addresses[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @brand_id OUT, 'recipient_addresses[i].brand_id'
EXEC sp_OAMethod @jResp, 'StringOf', @cname_status OUT, 'recipient_addresses[i].cname_status'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'recipient_addresses[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @default OUT, 'recipient_addresses[i].default'
EXEC sp_OAMethod @jResp, 'StringOf', @dns_results OUT, 'recipient_addresses[i].dns_results'
EXEC sp_OAMethod @jResp, 'StringOf', @domain_verification_code OUT, 'recipient_addresses[i].domain_verification_code'
EXEC sp_OAMethod @jResp, 'StringOf', @domain_verification_status OUT, 'recipient_addresses[i].domain_verification_status'
EXEC sp_OAMethod @jResp, 'StringOf', @forwarding_status OUT, 'recipient_addresses[i].forwarding_status'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'recipient_addresses[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'recipient_addresses[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @spf_status OUT, 'recipient_addresses[i].spf_status'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'recipient_addresses[i].updated_at'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
