Поделиться через

Получение списка потенциальных клиентов и возможностей

  • Статья

В этой статье объясняется, как получить список потенциальных клиентов, полученных от страницы поставщика решений Майкрософт, и совместно продавать возможности, полученные от продавцов Майкрософт или других партнеров. Этот процесс также получит список возможностей совместного продажи или сделок конвейера, созданных вашей организацией.

Примечание.

Потенциальные клиенты, полученные от коммерческой платформы Майкрософт (Azure Marketplace и AppSource), не поддерживаются.

Необходимые компоненты

  • Учетные данные, описанные в статье об аутентификации в API для партнеров. Этот сценарий поддерживает проверку подлинности с использованием учетных данных приложений и пользователей.
  • Этот API в настоящее время поддерживает только доступ пользователей, где партнеры должны находиться в одной из следующих ролей: глобальный администратор, администратор рефералов или пользователь рефералов.

Запрос REST

Синтаксис запроса

Способ URI запроса
GET https://api.partner.microsoft.com/v1.0/engagements/referrals

Поддерживаемые операции OData

Имя Описание Обязательное поле Пример
$select Выбирает поля No /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 параметры для сортировки списка потенциальных клиентов и возможностей

Имя. Тип Описание
createdDateTime Дата/время Дата и время создания потенциальных или возможных возможностей
updatedDateTime Дата/время Обновление даты и времени потенциальных или возможных возможностей

Заголовки запросов

См. сведения о заголовках 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
Content-Type: application/json
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731

{
  "@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": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
      "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 последних возможностей для входящего совместного продажи. Запрос получает возможности, инициированные представителем по продажам Майкрософт или другим партнером, приглашая вашу организацию участвовать в совместной деятельности.

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

Внимание

Если вы не отвечаете на потенциальные или возможности в течение выделенного времени (в настоящее время 14 дней), мы заархивируем его как истекший срок действия и уведомим майкрософт или партнера, отправившего вам эту возможность.

Следующий пример получает самые последние активные возможности совместного продажи, инициированные вашей организацией и работая с конкретным продавцом.

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

Связанный контент