Skip to content

提交及状态查询商家名片配置申请

提交商家名片配置申请

本接口面向服务商(不包括银行、支付机构、电商平台),用于提交商家名片配置申请,支持配置商家服务列表(用户可点击跳转至小程序或网页)和多渠道客服信息(包括自研客服、客服电话等),配置提交后返回名片预览二维码链接供商家验证跳转路径是否符合预期。

📌

注意:接口采用全量覆盖机制,每次提交均视为完整配置。最新提交将完全覆盖历史配置,不支持多轮次增量更新,请确保每次请求包含完整的配置信息。

请求参数类型描述
jsonobject声明请求的JSON数据结构
business_codestring业务申请编号
brand_idstring品牌ID
brand_mini_program_infoobject品牌小程序信息
appidstring公众账号ID
default_jump_pathstring小程序默认跳转路径
brand_customer_serviceobject品牌客服信息
customer_service_typestring客服类型
MINI_PROGRAM | CUSTOMIZE_WEB | CUSTOMIZE_MP | SERVICE_PHONE 枚举值之一
customer_service_phonestring客服电话
customer_service_pathstring客服路径
appidstring公众账号ID
service_listobject[]服务列表
service_classify_namestring服务分类名称
service_namestring服务名称
service_jump_typestring服务跳转类型
JUMP_MINI_PROGRAM | JUMP_WEB_PAGE 枚举值之一
service_jump_pathstring服务跳转路径
appidstring公众账号ID
php
$instance->v3->brand->card->cardConfigs->postAsync([
  'json' => [
    'business_code'           => '190001351110000',
    'brand_id'                => '1004',
    'brand_mini_program_info' => [
      'appid'             => 'wx1234567890abcdef',
      'default_jump_path' => 'pages/shop/index',
    ],
    'brand_customer_service'  => [
      'customer_service_type'  => 'MINI_PROGRAM',
      'customer_service_phone' => '12345678900',
      'customer_service_path'  => 'pages/service/index',
      'appid'                  => 'wx1234567890abcdef',
    ],
    'service_list'            => [[
      'service_classify_name' => '会员服务',
      'service_name'          => '会员中心',
      'service_jump_type'     => 'JUMP_MINI_PROGRAM',
      'service_jump_path'     => 'pages/shop/index',
      'appid'                 => 'wx1234567890abcdef',
    ],],
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$instance->chain('v3/brand/card/card-configs')->postAsync([
  'json' => [
    'business_code'           => '190001351110000',
    'brand_id'                => '1004',
    'brand_mini_program_info' => [
      'appid'             => 'wx1234567890abcdef',
      'default_jump_path' => 'pages/shop/index',
    ],
    'brand_customer_service'  => [
      'customer_service_type'  => 'MINI_PROGRAM',
      'customer_service_phone' => '12345678900',
      'customer_service_path'  => 'pages/service/index',
      'appid'                  => 'wx1234567890abcdef',
    ],
    'service_list'            => [[
      'service_classify_name' => '会员服务',
      'service_name'          => '会员中心',
      'service_jump_type'     => 'JUMP_MINI_PROGRAM',
      'service_jump_path'     => 'pages/shop/index',
      'appid'                 => 'wx1234567890abcdef',
    ],],
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$instance['v3/brand/card/card-configs']->postAsync([
  'json' => [
    'business_code'           => '190001351110000',
    'brand_id'                => '1004',
    'brand_mini_program_info' => [
      'appid'             => 'wx1234567890abcdef',
      'default_jump_path' => 'pages/shop/index',
    ],
    'brand_customer_service'  => [
      'customer_service_type'  => 'MINI_PROGRAM',
      'customer_service_phone' => '12345678900',
      'customer_service_path'  => 'pages/service/index',
      'appid'                  => 'wx1234567890abcdef',
    ],
    'service_list'            => [[
      'service_classify_name' => '会员服务',
      'service_name'          => '会员中心',
      'service_jump_type'     => 'JUMP_MINI_PROGRAM',
      'service_jump_path'     => 'pages/shop/index',
      'appid'                 => 'wx1234567890abcdef',
    ],],
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$response = $instance->v3->brand->card->cardConfigs->post([
  'json' => [
    'business_code'           => '190001351110000',
    'brand_id'                => '1004',
    'brand_mini_program_info' => [
      'appid'             => 'wx1234567890abcdef',
      'default_jump_path' => 'pages/shop/index',
    ],
    'brand_customer_service'  => [
      'customer_service_type'  => 'MINI_PROGRAM',
      'customer_service_phone' => '12345678900',
      'customer_service_path'  => 'pages/service/index',
      'appid'                  => 'wx1234567890abcdef',
    ],
    'service_list'            => [[
      'service_classify_name' => '会员服务',
      'service_name'          => '会员中心',
      'service_jump_type'     => 'JUMP_MINI_PROGRAM',
      'service_jump_path'     => 'pages/shop/index',
      'appid'                 => 'wx1234567890abcdef',
    ],],
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
php
$response = $instance->chain('v3/brand/card/card-configs')->post([
  'json' => [
    'business_code'           => '190001351110000',
    'brand_id'                => '1004',
    'brand_mini_program_info' => [
      'appid'             => 'wx1234567890abcdef',
      'default_jump_path' => 'pages/shop/index',
    ],
    'brand_customer_service'  => [
      'customer_service_type'  => 'MINI_PROGRAM',
      'customer_service_phone' => '12345678900',
      'customer_service_path'  => 'pages/service/index',
      'appid'                  => 'wx1234567890abcdef',
    ],
    'service_list'            => [[
      'service_classify_name' => '会员服务',
      'service_name'          => '会员中心',
      'service_jump_type'     => 'JUMP_MINI_PROGRAM',
      'service_jump_path'     => 'pages/shop/index',
      'appid'                 => 'wx1234567890abcdef',
    ],],
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
php
$response = $instance['v3/brand/card/card-configs']->post([
  'json' => [
    'business_code'           => '190001351110000',
    'brand_id'                => '1004',
    'brand_mini_program_info' => [
      'appid'             => 'wx1234567890abcdef',
      'default_jump_path' => 'pages/shop/index',
    ],
    'brand_customer_service'  => [
      'customer_service_type'  => 'MINI_PROGRAM',
      'customer_service_phone' => '12345678900',
      'customer_service_path'  => 'pages/service/index',
      'appid'                  => 'wx1234567890abcdef',
    ],
    'service_list'            => [[
      'service_classify_name' => '会员服务',
      'service_name'          => '会员中心',
      'service_jump_type'     => 'JUMP_MINI_PROGRAM',
      'service_jump_path'     => 'pages/shop/index',
      'appid'                 => 'wx1234567890abcdef',
    ],],
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
返回字典类型描述
business_codestring业务申请编号
brand_idstring品牌ID
applyment_idstring微信支付申请单号
card_preview_urlstring商家名片预览二维码链接

参阅 官方文档

查询商家名片配置申请状态

接口适用场景:服务商提交配置商家名片配置申请后,可调用此接口查询申请状态。

请求参数类型描述
queryobject声明请求的查询参数
business_codestring业务申请编号
applyment_idstring微信支付申请单号
brand_idstring品牌ID
php
$instance->v3->brand->card->cardConfigs->getAsync([
  'query' => [
    'business_code' => '190001351110000',
    'applyment_id'  => '1111111111',
    'brand_id'      => '120344',
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$instance->chain('v3/brand/card/card-configs')->getAsync([
  'query' => [
    'business_code' => '190001351110000',
    'applyment_id'  => '1111111111',
    'brand_id'      => '120344',
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$instance['v3/brand/card/card-configs']->getAsync([
  'query' => [
    'business_code' => '190001351110000',
    'applyment_id'  => '1111111111',
    'brand_id'      => '120344',
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$response = $instance->v3->brand->card->cardConfigs->get([
  'query' => [
    'business_code' => '190001351110000',
    'applyment_id'  => '1111111111',
    'brand_id'      => '120344',
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
php
$response = $instance->chain('v3/brand/card/card-configs')->get([
  'query' => [
    'business_code' => '190001351110000',
    'applyment_id'  => '1111111111',
    'brand_id'      => '120344',
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
php
$response = $instance['v3/brand/card/card-configs']->get([
  'query' => [
    'business_code' => '190001351110000',
    'applyment_id'  => '1111111111',
    'brand_id'      => '120344',
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
返回字典类型描述
business_codestring业务申请编号
applyment_idstring微信支付申请单号
brand_idstring品牌ID
applyment_statestring申请单状态
STATE_UNKNOWN | DRAFTING | AUDITING | AUDIT_REJECTED | PENDING_PUBLISH | PUBLISHED | CANCELED 枚举值之一
scheduled_publish_timestring定时发布时间
reject_reasonstring驳回原因
actual_publish_timestring实际发布时间

参阅 官方文档

Published on the GitHub by TheNorthMemory