Dapatkan daftar prospek dan peluang
Artikel ini menjelaskan cara mendapatkan daftar prospek dan peluang Penjualan bersama. Prospek ini diterima dari halaman Penyedia Solusi Microsoft, sedangkan peluang Penjualan bersama diterima dari penjual Microsoft atau mitra lain. Proses ini juga mengambil daftar peluang penjualan bersama atau penawaran alur yang dibuat oleh organisasi Anda.
Catatan
Prospek yang diterima dari marketplace komersial Microsoft (Marketplace Azure dan AppSource) tidak didukung.
Prasyarat
- Kredensial seperti yang dijelaskan dalam autentikasi API Rujukan. Skenario ini mendukung autentikasi dengan kredensial App+User.
- API ini saat ini hanya mendukung akses pengguna di mana mitra harus berada dalam salah satu peran berikut: Admin Rujukan atau Pengguna Rujukan.
Permintaan REST
Minta sintaks
Metode | URI Permintaan |
---|---|
DAPATKAN | https://api.partner.microsoft.com/v1.0/engagements/referrals |
Operasi OData yang didukung
Nama | Deskripsi | Wajib diisi | Contoh |
---|---|---|---|
$select | Memilih bidang | No | /referrals?$select=id,status,customerProfile |
$filter | Memfilter hasil | Direkomendasikan | /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 | Hasil pesanan | Direkomendasikan | /referrals?$orderby=createdDateTime desc |
Parameter orderby yang didukung
Gunakan parameter $orderby berikut untuk mengurutkan daftar prospek dan peluang
Nama | Tipe | Deskripsi |
---|---|---|
createdDateTime | DateTime | Tanggal dan waktu pembuatan prospek atau peluang |
updatedDateTime | DateTime | Perbarui tanggal dan waktu prospek atau peluang |
Header permintaan
Untuk informasi selengkapnya, lihat Header REST Mitra.
Isi permintaan
Tidak ada.
Contoh permintaan
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Respons REST
Jika berhasil, isi respons berisi kumpulan prospek dan/atau peluang.
Kode kesalahan dan keberhasilan respons
Setiap respons dilengkapi dengan kode status HTTP yang menunjukkan keberhasilan atau kegagalan dan informasi penelusuran kesalahan lainnya. Gunakan alat pelacakan jaringan untuk membaca kode ini, jenis kesalahan, dan lebih banyak parameter.
Contoh tanggapan
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
Gunakan untuk mendapatkan halaman hasil berikutnya.
Catatan
Bidang dalam contoh ini tidak lengkap. Respons API aktual berisi lebih banyak bidang seperti pelanggan dan tim mitra. Untuk daftar lengkap bidang yang didukung, lihat sumber daya rujukan.
Sampel permintaan
Contoh berikut mengambil 10 peluang penjualan bersama masuk terbaru. Permintaan ini mengambil peluang yang dimulai oleh perwakilan penjualan Microsoft atau mitra lain, mengundang organisasi Anda untuk berpartisipasi dalam aktivitas penjualan bersama.
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
Contoh berikut mengambil prospek dan peluang masuk terbaru yang tidak ditanggapi.
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
Penting
Jika Anda tidak menanggapi prospek atau kesempatan dalam waktu yang dialokasikan (saat ini 14 hari), kami akan mengarsipkannya sebagai Kedaluwarsa dan memberi tahu Microsoft atau mitra yang mengirimi Anda kesempatan ini.
Contoh berikut mendapatkan peluang penjualan bersama aktif terbaru yang dimulai oleh organisasi Anda dan dikerjakan oleh penjual tertentu.
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