接口封装进展.md · OSCHINA-MIRROR/hm-tools-hm-tools-wxmp-adapter

1. Начало разработки

Подключение:
- инструкция по подключению;
- описание домена интерфейса.
Получение access_token.
Запрос номера для тестирования.
Инструкция по устранению неполадок с оповещениями.
Онлайн-отладка интерфейса.
Поиск IP-адреса сервера WeChat.
Сетевое обнаружение.
Часто задаваемые вопросы.

2. Создание меню

Создание меню: top.hmtools.wxmp.menu.apis.IMenuApi.createMenu(MenuBean).
Получение меню: top.hmtools.wxmp.menu.apis.IMenuApi.getMenu().
Удаление всех меню: top.hmtools.wxmp.menu.apis.IMenuApi.deleteAllMenu().
Отправка событий меню:
- событие отправки сообщения при нажатии на меню: top.hmtools.wxmp.menu.models.eventMessage.ClickEventMessage;
- событие перехода по ссылке при нажатии на меню: top.hmtools.wxmp.menu.models.eventMessage.ViewEventMessage;
- событие push-уведомления при сканировании кода: top.hmtools.wxmp.menu.models.eventMessage.ScancodePushEventMessage;
- событие push-уведомления с всплывающим окном «Получение сообщения»: top.hmtools.wxmp.menu.models.eventMessage.ScancodeWaitmsgEventMessage;
- событие отправки фото с камеры: top.hmtools.wxmp.menu.models.eventMessage.PicSysPhotoEventMessage;
- событие отправки фотографии из галереи или альбома: top.hmtools.wxmp.menu.models.eventMessage.PicPhotoOrAlbumEventMessage;
- событие отправки изображения из галереи WeChat: top.hmtools.wxmp.menu.models.eventMessage.PicWeixinEventMessage;
- событие открытия окна выбора местоположения: top.hmtools.wxmp.menu.models.eventMessage.LocationSelectEventMessage;
- событие перехода в мини-программу при нажатии на меню: top.hmtools.wxmp.menu.models.eventMessage.ViewMiniprogramEventMessage.
Индивидуальное меню:
- создание индивидуального меню: top.hmtools.wxmp.menu.apis.IConditionalMenuApi.addConditional(ConditionalMenuBean);
- удаление индивидуального меню: top.hmtools.wxmp.menu.apis.IConditionalMenuApi.delConditional(ConditionalBean);
- проверка соответствия индивидуального меню: top.hmtools.wxmp.menu.apis.IConditionalMenuApi.tryMatch(TryMatchParamBean);
- получение индивидуального меню: используется обычный метод получения меню, см. выше;
- удаление всех меню: используется общий метод удаления меню, см. выше.
Настройка индивидуального меню: top.hmtools.wxmp.menu.models.simple.CurrentSelfMenuInfoBean.

3. Управление сообщениями (разработка продолжается, тестирование не проводилось)

Приём обычных сообщений:
- текстовое сообщение: top.hmtools.wxmp.message.ordinary.model.TextMessage;
- изображение: top.hmtools.wxmp.message.ordinary.model.ImageMessage;
- голосовое сообщение: top.hmtools.wxmp.message.ordinary.model.VoiceMessage;
- видео: top.hmtools.wxmp.message.ordinary.model.VideoMessage;
- короткое видео: top.hmtools.wxmp.message.ordinary.model.ShortvideoMessage;
- местоположение: top.hmtools.wxmp.message.ordinary.model.LocationMessage;
- ссылка: top.hmtools.wxmp.message.ordinary.model.LinkMessage.
Обработка событий push:
- подписка/отписка: top.hmtools.wxmp.message.eventPush.model.SubscribeEventMessage, top.hmtools.wxmp.message.eventPush.model.UnsubscribeEventMessage;
- сканирование кода с параметрами: top.hmtools.wxmp.message.eventPush.model.QRSubscribeEventMessage и top.hmtools.wxmp.message.eventPush.model.QRScanEventMessage (при отсутствии подписки msgType и event имеют те же значения, что и в событии SubscribeEventMessage);
- отправка местоположения: top.hmtools.wxmp.message.eventPush.model.LocationEventMessage;
- события меню: см. пункты 5 и 6 в разделе «Создание меню».
Ответ пользователю:
- ответ текстом: top.hmtools.wxmp.message.reply.model.ReplyTextMessage;
- ответ изображением: top.hmtools.wxmp.message.reply.model.ReplyImageMessage;
- ответ голосом: top.hmtools.wxmp.message.reply.model.ReplyVoiceMessage;
- ответ видео: top.hmtools.wxmp.message.reply.model.ReplyVideoMessage;
- ответ музыкой: top.hmtools.wxmp.message.reply.model.ReplyMusicMessage;
- ответ новостью: top.hmtools.wxmp.message.reply.model.ReplyNewsMessage.
Шифрование и расшифровка сообщений: https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Message_encryption_and_decryption_instructions.html.
Обслуживание клиентов:
- управление учётными записями службы поддержки:
  - добавление учётной записи службы поддержки: top.hmtools.wxmp.message.customerService.apis.ICustomerServiceApi.addKfAcount(KfAccountParam);
  - обновление учётной записи службы поддержки: top.hmtools.wxmp.message.customerService.apis.ICustomerServiceApi.updateKfAcount(KfAccountParam);
  - удаление учётной записи службы поддержки. Топ. HMtools. wxmp. message. customerService. apis. ICustomerServiceApi. deleteKfAccount(KfAccountParam)
- 1.4 Установить аватар для сервисного аккаунта топ. HMtools. wxmp. message. customerService. apis. ICustomerServiceApi. uploadHeadImg(UploadHeadImgParam)
- 1.5 Получить список всех сервисных аккаунтов топ. HMtools. wxmp. message. customerService. apis. ICustomerServiceApi. getKfList()
- 1.6 Унифицированное описание параметров интерфейса https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#6
- 2 Интерфейс обслуживания клиентов — отправка сообщений топ. HMtools. wxmp. message. customerService. apis. ICustomerServiceApi. sendMessage(BaseSendMessageParam), топ. HMtools. wxmp. message. customerService. model. sendMessage (пакет, содержащий структуру данных сообщения):
  - Текстовое сообщение топ. HMtools. wxmp. message. customerService. model.sendMessage. TextCustomerServiceMessage
  - Изображенческое сообщение топ. HMtools. wxmp. message. customerService. model. sendMessage. ImageCustomerServiceMessage
  - Голосовое сообщение топ. HMtools. wxmp. message. customerService. model. sendMessage. VoiceCustomerServiceMessage
  - Видеосообщение топ. HMtools. wxmp. message. customerService. model. sendMessage. VideoCustomerServiceMessage
  - Музыкальное сообщение топ. HMtools. wxmp. message. customerService. model. sendMessage. MusicCustomerServiceMessage
  - Сообщение с гиперссылкой на статью топ. HMtools. wxmp. message. customerService. model. sendMessage. NewsCustomerServiceMessage
  - Сообщение с переходом на страницу статьи топ. HMtools. wxmp. message. customerService. model. sendMessage. MpnewsCustomerServiceMessage
  - Меню сообщений топ. HMtools. wxmp. message. customerService. model. sendMessage. MenuCustomerServiceMessage
  - Карточка топ. HMtools. wxmp. message. customerService. model. sendMessage. WxcardCustomerServiceMessage
  - Мини-программная карточка (требуется связь между мини-программой и публичным аккаунтом) топ. HMtools. wxmp. message. customerService. model. sendMessage. MiniProgramCustomerServiceMessage
- 3 Интерфейс обслуживания клиентов — статус ввода топ. HMtools. wxmp. message. customerService. apis. ICustomerServiceApi. typingStatus(TypingStatusParam)

Групповая рассылка и проверка оригинальности
- 1 Загрузить изображение в текстовое сообщение (доступно после аутентификации как для подписных, так и для служебных аккаунтов) топ. HMtools. wxmp. message. group. apis. IGroupMessageApi. uploadImage(UploadImageParam)
- 2 Загрузить материалы для текстового сообщения (доступно после аутентификации как для подписных, так и для служебных аккаунтов) топ. HMtools. wxmp. message. group. apis. IGroupMessageApi. uploadNews(UploadNewsParam)
- 3 Рассылка по группам с использованием тегов (доступно после аутентификации как для подписных, так и для служебных аккаунтов) топ. HMtools. wxmp. message. group. apis. IGroupMessageApi. tagGroupMessageSend(BaseTagGroupSendParam):
  - текстовое сообщение: топ. HMtools. wxmp. message. group. model. tagGroupSend. TextTagGroupSendParam
  - голосовое/аудиосообщение (необходимо получить media_id через управление материалами -> добавить материал): топ. HMtools. wxmp. message. group. model. tagGroupSend. VoiceTagGroupSendParam
  - изображение (необходимо получить media_id через управление материалами -> добавить материал): топ. HMtools. wxmp. message. group. model. tagGroupSend. ImageTagGroupSendParam
  - видео: топ. HMtools. wxmp. message. group. model. tagGroupSend. VideoTagGroupSendParam
  - карточка (необходимо получить media_id с помощью описанного выше метода): топ. HMtools. wxmp. message. group. model. tagGroupSend. WxcardTagGroupSendParam
- 4 Рассылка по группам на основе списка OpenID (доступно только после аутентификации служебного аккаунта) топ. HMtools. wxmp. message. group. apis. IGroupMessageApi. openIdGroupMessageSend(BaseOpenIdGroupSendParam):
  - текстовое сообщение: топ. HMtools. wxmp. message. group. model. openIdGroupSend. TextOpenIdGroupSendParam
  - голосовое сообщение: топ. HMtools. wxmp. message. group. model. openIdGroupSend. VoiceOpenIdGroupSendParam
  - изображение: топ. HMtools. wxmp. message. group. model. openIdGroupSend. ImageOpenIdGroupSendParam
  - видео: топ. HMtools. wxmp. message. group. model. openIdGroupSend. MpVideoOpenIdGroupSendParam
  - карточка: топ. HMtools. wxmp. message. group. model. openIdGroupSend. WxcardOpenIdGroupSendParam
- 5 Удалить групповую рассылку (доступно после аутентификации как для подписного, так и для служебного аккаунта) топ. HMtools. wxmp. message. group. apis. IGroupMessageApi. deleteGroupMessageSended(DeleteParam)
- 6 Предварительный просмотр (доступно после аутентификации как для подписного, так и для служебного аккаунта) топ. HMtools. wxmp. message. group. apis. IGroupMessageApi. previewGroupMessageSend(BasePreviewParam):
  - текстовое сообщение (media_id совпадает с media_id из групповой рассылки с использованием тегов): топ. HMtools. wxmp. message. group. model. preview. MpnewsPreviewParam Текст:

top.hmtools.wxmp.message.group.model.preview.TextPreviewParam — текст;
top.hmtools.wxmp.message.group.model.preview.VoicePreviewParam — аудио (где media_id совпадает с media_id в групповом сообщении);
top.hmtools.wxmp.message.group.model.preview.ImagePreviewParam — изображение (где media_id совпадает с media_id в групповом сообщении);
top.hmtools.wxmp.message.group.model.preview.MpvedioPreviewParam — видео (где media_id совпадает с media_id в групповом сообщении);
top.hmtools.wxmp.message.group.model.preview.WxcardPreviewParam — купон.

7. Запрос состояния отправки группового сообщения:

top.hmtools.wxmp.message.group.apis.IGroupMessageApi.getGroupMessageSendStatus(GroupMessageSendStatusParam).

8. Отправка события группового сообщения:

top.hmtools.wxmp.message.group.model.event.GroupMessageSendEvent.

9. Использование параметра clientmsgid для предотвращения повторной отправки:

https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#8.

10. Контроль скорости отправки групповых сообщений:

получение скорости отправки: top.hmtools.wxmp.message.group.apis.IGroupMessageApi.getGroupMessageSendSpeed();
установка скорости отправки: top.hmtools.wxmp.message.group.apis.IGroupMessageApi.setGroupMessageSendSpeed(SpeedParam).

Шаблоны сообщений:

настройка отрасли: top.hmtools.wxmp.message.template.apis.ITemplateApi.setIndustry(SetIndustryParam);
получение информации о настройке отрасли: top.hmtools.wxmp.message.template.apis.ITemplateApi.getIndustry();
получение идентификатора шаблона: top.hmtools.wxmp.message.template.apis.ITemplateApi.getTemplateId(TemplateIdParam);
получение списка шаблонов: top.hmtools.wxmp.message.template.apis.ITemplateApi.getAllPrivateTemplate();
удаление шаблона: top.hmtools.wxmp.message.template.apis.ITemplateApi.delPrivateTemplate(DelTemplateParam);
отправка шаблонного сообщения: top.hmtools.wxmp.message.template.apis.ITemplateApi.sendTemplateMessage(SendTemplateMessageParam);
событие отправки шаблонного сообщения: top.hmtools.wxmp.message.template.model.event.TemplateMessageSendedEvent.

Одноразовые подписки на сообщения:

—

Управление шаблонами сообщений:

—

Ограничения на количество вызовов интерфейса:

—

Получение правил автоматического ответа для публичного аккаунта:

—

3. Разработка веб-страниц WeChat:

разработка адаптивных веб-приложений для iOS с использованием WKWebview: веб-приложение WeChat, адаптированное под iOS;
авторизация веб-страницы WeChat: top.hmtools.wxmp.webpage.authorize.OAuth2Tools;
библиотека стилей WeUI для разработки веб-страниц: http://weui.io/;
документация по WeChat JS-SDK: top.hmtools.wxmp.webpage.jsSdk.JsSdkTools;
инструменты разработчика WeChat для веб-разработчиков: —.

4. Управление материалами:

добавление временных материалов: top.hmtools.wxmp.material.apis.ITemporaryApi.uploadMedia(UploadParam);
получение временных материалов:
- изображения: top.hmtools.wxmp.material.apis.ITemporaryApi.getImage(MediaParam),
- видео: top.hmtools.wxmp.material.apis.ITemporaryApi.getVideo(MediaParam);
добавление постоянных материалов:
- новости: top.hmtools.wxmp.material.apis.IForeverApi.addNews(NewsBean),
- изображение для новостей: top.hmtools.wxmp.material.apis.IForeverApi.uploadImageForNews(UploadParam),
- материалы: top.hmtools.wxmp.material.apis.IForeverApi.addMaterial(UploadParam);
получение постоянных материалов: изображения: top.hmtools.wxmp.material.apis.IForeverApi.getMaterialImage(MediaParam);
удаление постоянных материалов: top.hmtools.wxmp.material.apis.IForeverApi.delMaterial(MediaParam);
обновление постоянных графических и текстовых материалов: top.hmtools.wxmp.material.apis.IForeverApi.updateNews(NewsBeanForUpdate) — не проверено;
получение общего количества материалов: top.hmtools.wxmp.material.apis.IForeverApi.getMaterialCount();
получение пакета материалов: top.hmtools.wxmp.material.apis.IForeverApi.getBatchgetMaterial(BatchgetMaterialParam).

5. Управление комментариями к статьям:

управление комментариями к статьям:
- добавление постоянных материалов (изменённый исходный интерфейс): 4. Управление материалами;
- получение постоянных материалов (изменённый исходный интерфейс): 4. Управление материалами;
- обновление постоянных графических и текстовых материалов (изменённый исходный интерфейс): 4. Управление материалами;
- получение пакета материалов (изменённый исходный интерфейс): 4. Управление материалами;
открытие комментариев к уже опубликованным статьям: top.hmtools.wxmp.comment.apis.ICommentApi.openComment(OpenCommentParam);
закрытие комментариев к уже опубликованным статьям: top.hmtools.wxmp.comment.apis.ICommentApi.closeComment(OpenCommentParam);
просмотр данных комментариев к указанной статье: top.hmtools.wxmp.comment.apis.ICommentApi.listComment(ListCommentParam);
маркировка комментариев как избранных: top.hmtools.wxmp.comment.apis.ICommentApi.markelectComment(UserCommentParam);
отмена маркировки комментариев как избранных: top.hmtools.wxmp.comment.apis.ICommentApi.unmarkelectComment(UserCommentParam);
удаление комментариев: top.hmtools.wxmp.comment.apis.ICommentApi.deleteComment(UserCommentParam);
ответ на комментарии: top.hmtools.wxmp.comment.apis.ICommentApi.replyComment(ReplyCommentParam);
удаление ответов на комментарии: top.hmtools.wxmp.comment.apis.ICommentApi.deleteReplyComment(UserCommentParam).

6. Управление пользователями:

— Управление пользовательскими тегами

Создание тегов: top.hmtools.wxmp.user.apis.ITagsApi.create(TagWapperParam).
Получение уже созданных тегов публичного аккаунта: top.hmtools.wxmp.user.apis.ITagsApi.get().
Редактирование тегов: top.hmtools.wxmp.user.apis.ITagsApi.update(TagWapperParam).
Удаление тегов: top.hmtools.wxmp.user.apis.ITagsApi.delete(TagWapperParam).
Получение списка поклонников под тегом: top.hmtools.wxmp.user.apis.ITagsApi.getFunsOfTag(TagFunsParam).
Пакетное присвоение тегов пользователю: top.hmtools.wxmp.user.apis.ITagsApi.batchTagging(BatchTagParam).
Пакетное удаление тегов у пользователя: top.hmtools.wxmp.user.apis.ITagsApi.batchUntagging(BatchTagParam).
Получение списка тегов, присвоенных пользователю: top.hmtools.wxmp.user.apis.ITagsApi.getTaglistByOpenid(TagListParam).

Установка примечаний к учётной записи пользователя

top.hmtools.wxmp.user.apis.IRemarkApi.updateRemark(RemarkParam).

Получение основной информации о пользователе (включая UnionID)

Получение основной информации о пользователе: top.hmtools.wxmp.user.apis.IUnionIDApi.getUserInfo(UserInfoParam).
Пакетное получение основной информации о пользователях: top.hmtools.wxmp.user.apis.IUnionIDApi.getBatchUserInfo(BatchUserInfoParam).

Получение списка пользователей

top.hmtools.wxmp.user.apis.IUserListApi.getUserList(UserListParam).

Управление чёрным списком

Получение чёрного списка публичного аккаунта: top.hmtools.wxmp.user.apis.IBlackListApi.getBlackList(BlackListParam).
Добавление пользователя в чёрный список: top.hmtools.wxmp.user.apis.IBlackListApi.batchBlackList(BatchBlackListParam).
Отмена добавления пользователя в чёрный список: top.hmtools.wxmp.user.apis.IBlackListApi.batchUnblackList(BatchBlackListParam). Документация по мини-программе

— Документация платформы открытого доступа WeChat

20. Товары в WeChat

— testczc — Не облагаемый налогом платёж через WeChat

21. Не облагаемый налогом платёж через WeСhat

— Документация интерфейса не облагаемого налогом платежа через WeChat; — Руководство по подключению не облагаемого налогом платежа через WeChat; — Документация платформы интерфейса не облагаемого налогом платежа для владельцев транспортных средств через WeChat.

OSCHINA-MIRROR/hm-tools-hm-tools-wxmp-adapter

20. Товары в WeChat

21. Не облагаемый налогом платёж через WeСhat

22. Распределённая поддержка

Опубликовать ( 0 )

Введение

Обновления

Участники

Недавние действия

OSCHINA-MIRROR/hm-tools-hm-tools-wxmp-adapter .gitee-modal { min-width: 500px !important; } .gitee-modal .close { right: 0.6rem !important; }

20. Товары в WeChat

21. Не облагаемый налогом платёж через WeСhat

22. Распределённая поддержка

Опубликовать ( 0 )

Введение

Обновления

Участники

Недавние действия

OSCHINA-MIRROR/hm-tools-hm-tools-wxmp-adapter