Müşteri adaylarının ve fırsatların listesini alma
Bu makalede, müşteri adayları ve Ortak satış fırsatlarının listesini nasıl edinecekleri açıklanmaktadır. Bu müşteri adayları Microsoft'un Çözüm Sağlayıcısı sayfasından, Ortak satış fırsatları ise Microsoft satıcılarından veya diğer iş ortaklarından alınır. Bu işlem, kuruluşunuz tarafından oluşturulan ortak satış fırsatlarının veya işlem hattı anlaşmalarının listesini de getirir.
Not
Microsoft ticari marketinden (Azure Market ve AppSource) alınan müşteri adayları desteklenmez.
Önkoşullar
- Referanslar API kimlik doğrulaması bölümünde açıklandığı gibi kimlik bilgileri. Bu senaryo, App+User kimlik bilgileriyle kimlik doğrulamayı destekler.
- Bu API şu anda yalnızca iş ortaklarının şu rollerden birinde olması gereken kullanıcı erişimini destekler: Referans Yöneticisi veya Referans Kullanıcısı.
REST isteği
İstek söz dizimi
| Metot | İstek URI'si |
|---|---|
| GET | https://api.partner.microsoft.com/v1.0/engagements/referrals |
Desteklenen OData işlemleri
| Veri Akışı Adı | Açıklama | Gerekli | Örnek |
|---|---|---|---|
| $select | Alanları seçer | Hayır | /referrals?$select=id,status,customerProfile |
| $filter | Sonuçları filtreler | Önerilir | /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 | Sipariş sonuçları | Önerilir | /referrals?$orderby=createdDateTime desc |
Desteklenen orderby parametreleri
Müşteri adayları ve fırsatlar listesini sıralamak için aşağıdaki $orderby parametrelerini kullanın
| Adı | Tür | Açıklama |
|---|---|---|
| createdDateTime | DateTime | Müşteri adayının veya fırsatın oluşturma tarihi ve saati |
| updatedDateTime | DateTime | Müşteri adayının veya fırsatın tarih ve saatini güncelleştirme |
İstek üst bilgileri
Daha fazla bilgi için bkz . İş ortağı REST üst bilgileri.
Request body
Yok.
İstek örneği
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
REST yanıtı
Başarılı olursa, yanıt gövdesi bir müşteri adayları ve/veya fırsatlar koleksiyonu içerir.
Yanıt başarısı ve hata kodları
Her yanıt, başarılı veya başarısız olduğunu ve diğer hata ayıklama bilgilerini gösteren bir HTTP durum koduyla birlikte gelir. Bu kodu, hata türünü ve diğer parametreleri okumak için bir ağ izleme aracı kullanın.
Yanıt örneği
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"
}
Sonuçların sonraki sayfasını almak için öğesini @odata.nextLink kullanın.
Not
Bu örnekteki alanlar kapsamlı değildir. Gerçek API yanıtı, müşteri ve iş ortağı ekipleri gibi daha fazla alan içerir. Desteklenen alanların tam listesi için bkz . referans kaynakları.
Örnek istekler
Aşağıdaki örnek, en son 10 gelen ortak satış fırsatı alır. İstek, bir Microsoft satış temsilcisi veya başka bir iş ortağı tarafından başlatılan fırsatları getirir ve kuruluşunuzu ortak satış etkinliğine katılmaya davet eder.
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
Aşağıdaki örnek, yanıtlanmayan en son gelen müşteri adaylarını ve fırsatları alır.
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
Önemli
Ayrılan süre içinde (şu anda 14 gün) bir müşteri adayına veya fırsata yanıt vermezseniz, bu müşteri adayını Süresi Doldu olarak arşivler ve size bu fırsatı gönderen Microsoft'a veya iş ortağına bildiririz.
Aşağıdaki örnek, kuruluşunuz tarafından başlatılan ve belirli bir satıcı tarafından üzerinde çalışılan en son etkin ortak satış fırsatlarını alır.
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