잠재 고객 및 기회 목록 가져오기
이 문서에서는 잠재 고객 및 공동 판매 기회 목록을 가져오는 방법을 설명합니다. 이러한 잠재 고객은 Microsoft의 솔루션 공급자 페이지에서 수신되는 반면 공동 판매 기회는 Microsoft 판매자 또는 다른 파트너로부터 받습니다. 또한 이 프로세스는 조직에서 만든 공동 판매 기회 또는 파이프라인 거래 목록을 가져옵니다.
참고 항목
Microsoft 상업용 Marketplace(Azure Marketplace 및 AppSource)에서 받은 잠재 고객은 지원되지 않습니다.
필수 조건
- 조회 API 인증에 설명된 자격 증명입니다. 이 시나리오는 앱+사용자 자격 증명을 통한 인증을 지원합니다.
- 이 API는 현재 파트너가 조회 관리자 또는 추천 사용자 역할 중 하나에 있어야 하는 사용자 액세스만 지원합니다.
REST 요청
요청 구문
| 메서드 | 요청 URI |
|---|---|
| GET | https://api.partner.microsoft.com/v1.0/engagements/referrals |
지원되는 OData 작업
| 속성 | 설명 | 필수 | 예시 |
|---|---|---|---|
| $select | 필드를 선택합니다. | 아니요 | /referrals?$select=id,status,customerProfile |
| $filter | 결과 필터링 | 권장 | /referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2' /referrals?$filter=status eq 'New' and qualification eq 'SalesQualified' /referrals?$filter=customerProfile/address/country eq 'US' and direction eq 'Incoming' |
| $orderby | 결과 정렬 | 권장 | /referrals?$orderby=createdDateTime desc |
지원되는 orderby 매개 변수
다음 $orderby 매개 변수를 사용하여 잠재 고객 및 기회 목록을 정렬합니다.
| 속성 | 형식 | 설명 |
|---|---|---|
| createdDateTime | DateTime | 잠재 고객 또는 기회의 생성 날짜 및 시간 |
| updatedDateTime | DateTime | 잠재 고객 또는 기회의 날짜 및 시간 업데이트 |
요청 헤더
자세한 내용은 파트너 REST 헤더를 참조 하세요.
요청 본문
없음
요청 예제
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
REST 응답
성공하면 응답 본문에 잠재 고객 및/또는 기회 컬렉션 이 포함됩니다.
응답 성공 및 오류 코드
각 응답에는 성공 또는 실패 및 기타 디버깅 정보를 나타내는 HTTP 상태 코드가 함께 제공됩니다. 네트워크 추적 도구를 사용하여 이 코드, 오류 유형 및 기타 매개 변수를 읽습니다.
응답 예제
HTTP/1.1 200 OK
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Content-Type: application/json
{
"@odata.context": "http://api.partner.microsoft.com/v1.0/$metadata#Referrals",
"@odata.count": 1,
"value": [
{
"id": "c5fbb3b6-be74-4795-9fb5-4324c73fed37",
"engagementId": "65edc0b5-3485-41b7-a17e-dfa9ef4706e2",
"organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"organizationName": "Contoso Company",
"createdDateTime": "2020-10-30T21:03:00.0000000Z",
"updatedDateTime": "2020-10-30T21:03:00.0000000Z",
"status": "New",
"substatus": "Pending",
"qualification": "Direct",
"type": "Independent",
"direction": "Incoming",
"customerProfile": {
"name": "Fabrikam Customer Inc",
"address": {
"addressLine1": "One Microsoft Way",
"addressLine2": "",
"city": "Redmond",
"state": "WA",
"postalCode": "98052",
"country": "US"
}
},
"details": {
"notes": "We are interested in deploying Microsoft 365 and are looking for support in training our employees. Can you help?",
"dealValue": 10000,
"currency": "USD",
"closingDateTime": "2020-12-01T00:00:00Z",
"requirements": {
"industries": [ { "id": "Education" } ],
"products": [ { "id": "Microsoft365" } ],
"services": [ { "id": "LearningAndCertification" } ],
"solutions": [ { "id": "SOL-Microsoft365", "name": "Microsoft365" }
]
}
},
"links": {
"relatedReferrals": {
"uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2'",
"method": "GET"
},
"self": {
"uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals/c5fbb3b6-be74-4795-9fb5-4324c73fed37",
"method": "GET"
}
}
}
],
"@odata.nextLink": "http://api.partner.microsoft.com/v1.0/referrals?$skiptoken=k181pEdP0ykypkieJfcxX"
}
결과의 @odata.nextLink 다음 페이지를 가져올 수 있습니다.
참고 항목
이 예제의 필드는 완전하지 않습니다. 실제 API 응답에는 고객 및 파트너 팀과 같은 더 많은 필드가 포함됩니다. 지원되는 필드의 전체 목록은 조회 리소스를 참조 하세요.
샘플 요청
다음 예제에서는 가장 최근의 인바운드 공동 판매 기회 상위 10개 항목을 검색합니다. 요청은 Microsoft 영업 담당자 또는 다른 파트너가 시작한 기회를 가져와 조직에게 공동 판매 활동에 참여하도록 초대합니다.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(type eq 'Shared' and direction eq 'Incoming')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
다음 예제에서는 응답하지 않는 가장 최근의 인바운드 잠재 고객 및 기회를 검색합니다.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(direction eq 'Incoming' and substatus eq 'Pending')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Important
할당된 시간(현재 14일) 내에 잠재 고객 또는 기회에 응답하지 않는 경우 만료됨으로 보관하고 Microsoft 또는 이 기회를 보낸 파트너에게 알립니다.
다음 예제에서는 조직에서 시작하고 특정 판매자가 작업 중인 가장 최근의 활성 공동 판매 기회를 가져옵니다.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=status eq 'Active' and direction eq 'Outgoing' and type eq 'Shared' and team/any(t:t/email eq 'r2d2@contoso.com')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json