SDK를 사용하여 Genesys Cloud Platform API 호출

Platform API 엔드포인트에 HTTP GET 요청을 보냅니다.

매개 변수

반환 값

예

다음 예는 특정 사용자에 대한 정보를 반환하고 /api/v2/users/{사용자 ID} 끝점.

HttpResponse response = purecloud.SDK.Rest.get('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263', new Map<String, String>{'CustomHeaderValue' => 'Foo'});

플랫폼 API 끝점에 HTTP PATCH 요청을 보냅니다.

매개 변수

반환 값

예

다음 예는 다음을 사용하여 채팅 참가자의 속성을 수정합니다. /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes 끝점. 요청 본문의 형식은 다음과 같습니다. { "속성": { "속성1": "John Doe", "attrib2": "푸"}}.

Map<String,Object> attributes = new Map<String,Object> { 
    'attrib1' => 'John Doe',
    'attrib2' => 'Foo'
};
Map<String,Object> body = new Map<String,Object> { 
    'attributes' => attributes 
};
HttpResponse response = purecloud.SDK.Rest.patch('/api/v2/conversations/chats/42a09688-c7e2-4d49-b9b8-8667d321a6f7/participants/5ad38568-9b97-4db6-850b-48b750566b06/attributes', JSON.serialize(body), new Map<String, String>{'CustomHeaderValue' => 'Foo'});

플랫폼 API 끝점에 HTTP POST 요청을 보냅니다.

매개 변수

반환 값

예

다음 예는 이름으로 사용자를 검색하고 /api/v2/users/search 끝점. 이 예제에서는 매핑된 두 개체를 사용하여 JSON 문자열을 생성합니다. 요청 본문의 형식은 다음과 같습니다. { "쿼리": [{ "필드": ["이름"], "값": "John Doe", "유형": "포함" }] }

Map<String,Object>query=new Map<String,Object>{
    'fields'=newList<String>{'name'},
    'value'=>'John Doe',
    'type' =>'CONTAINS'
};
Map<String,Object>body=newMap<String,Object>{
    'query' => new List<Object>{ query }
};
HttpResponse response = purecloud.SDK.Rest.post('/api/v2/users/search', JSON.serialize(body), new Map<String, String>{'CustomHeaderValue' => 'Foo'});

플랫폼 API 끝점에 HTTP PUT 요청을 보냅니다.

매개 변수

반환 값

예

다음 예는 특정 사용자에 대한 착신 전환 설정을 업데이트하고 /api/v2/users/{userId}/callForwarding 끝점. 

String body = '{ "enabled": true, "phoneNumber": "+13175550123" }';
HttpResponse response = purecloud.SDK.Rest.put('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263/callForwarding', body, new Map<String, String>{'CustomHeaderValue' => 'Foo'});

플랫폼 API 끝점에 HTTP DEL 요청을 보냅니다.

매개 변수

반환 값

예

HttpResponse response = purecloud.SDK.Rest.del('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263/station/associatedstation', new Map<String, String>{'CustomHeaderValue' => 'Foo'});