No project description provided
Project description
RCS-PYDANTIC
Introduce
한국 통신사 rcs 를 위한 pydantic 구조체
Installation
pip install rcs-pydantic
Quick start
from rcs_pydantic import MessageInfo, RcsMessage
message_info = {
"replyId": "B01RDSFR.KcNNLk67ui.FDSAF432153214",
"eventType":"newUser",
"displayText": "안녕",
"userContact":"01012341234",
"chatbotId":"0212351235",
"timeStamp": "2020-03-03T04:43:55.867+09"
}
rcs = {
"message_base_id": "SS000000",
"service_type": "RCSSMS",
"agency_id": "<str: agency_id>",
"body": {
"title": "타이틀",
"description": "일반 RCSSMS 테스트 메시지 입니다."
}
}
rcs_message = RcsMessage(message_info=MessageInfo(**message_info), **rcs)
>>> print(rcs_message.send_info)
common=CommonInfo(
msgId='4be0072f-0f05-4b3a-adc8-90d7ef309c53',
userContact='01012341234',
scheduleType=<ScheduleTypeEnum.IMMEDIATE: 0>,
msgServiceType=<MessageServiceTypeEnum.RCS: 'rcs'>
)
rcs=RcsInfo(
chatbotId='0212351235',
agencyId='<str: agency_id>',
messagebaseId='SS000000',
serviceType=<ServiceTypeEnum.SMS: 'RCSSMS'>,
expiryOption=<ExpiryOptionEnum.AFTER_SETTING_TIMES: 2>,
header=<HeaderEnum.NOT_ADVERTISE: '0'>,
copyAllowed=True,
body=RcsSMSBody(title='타이틀', description='일반 RCSSMS 테스트 메시지 입니다.'),
)
>>>
제공되는 항목
국내 통신사 RCS 문서에서 제공되는 모든 데이터 구조체를 지원합니다.
제공되는 데이터 구조체
RcsMessage
RCSErrorCode
RcsSMSBody
RcsLMSBody
RcsMMSBody
RcsCHATBody
RcsTMPLBody
RcsSMSCarouselBody
RcsLMSCarouselBody
RcsMMSCarouselBody
RcsCHATCarouselBody
LocationInfo
ShowLocationInfo
OpenUrlInfo
CreateCalendarEventInfo
CopyToClipboardInfo
ComposeTextMessageInfo
DialPhoneNumberInfo
UrlActionInfo
LocalBrowserActionInfo
MapActionInfo
CalendarActionInfo
ClipboardActionInfo
ComposeActionInfo
DialActionInfo
PostbackInfo
ActionInfo
SuggestionInfo
ButtonInfo
CommonInfo
RcsInfo
LegacyInfo
StatusInfo
QuerystatusInfo
ErrorInfo
ResponseErrorInfo
ResponseInfo
TextMessageInfo
FileMessageInfo
GeolocationPushMessage
UserLocationInfo
MessageInfo
SendInfo
TokenInfo
제공되는 데이터 관련 Enum
EventTypeEnum
RCSMessageEnum
MessageEnum
MessageStatusEnum
MnoInfoEnum
BillEnum
MessageServiceTypeEnum
ServiceTypeEnum
LegacyServiceTypeEnum
ScheduleTypeEnum
ExpiryOptionEnum
HeaderEnum
ActionEnum
제공되는 에러 코드 Enum
LegacyErrorCodeEnum
ErrorCodeEnum
MaaPErrorCodeEnum
RcsBizCenterErrorCodeEnum
KTErrorCodeEnum
RCSErrorCode
Features
RcsMessage
RcsMessage
클래스는 메세지 전송을 위한 SendInfo
구조체를 만듭니다.
from rcs_pydantic import MessageInfo, RcsMessage
message_info = {
"replyId": "B01RDSFR.KcNNLk67ui.FDSAF432153214",
"eventType":"newUser",
"displayText": "안녕",
"userContact":"01012341234",
"chatbotId":"0212351235",
"timeStamp": "2020-03-03T04:43:55.867+09"
}
rcs = {
"message_base_id": "SS000000",
"service_type": "RCSSMS",
"agency_id": "<str: agency_id>",
"body": {
"title": "타이틀",
"description": "일반 RCSSMS 테스트 메시지 입니다."
}
}
rcs_message = RcsMessage(message_info=MessageInfo(**message_info), **rcs)
MessageException
MessageException
예외 클래스는 여러 종류의 모든 error 코드를 포함하는 예외 클래스입니다.
from rcs_pydantic.exceptions import MessageException
raise MessageException(40003)
Contribution
이 프로젝트는 기여를 환영합니다!
패치를 제출하기 전에 issue 티켓을 먼저 제출해주세요.
Pull request 는 main
브랜치로 머지되며 항상 사용 가능한 상태로 유지해야 합니다.
모든 테스트 코드를 통과한 뒤 리뷰한 후 머지됩니다.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rcs-pydantic-0.1.23.tar.gz
(25.4 kB
view hashes)
Built Distribution
Close
Hashes for rcs_pydantic-0.1.23-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 479a492cda249c60ccbf8876d9ac067a1de28a6b9aa81b5091c5fc26199e3d6d |
|
MD5 | 46e0b0d983fdebc4a44e7a30173be814 |
|
BLAKE2b-256 | 08b1ed1996b978b575025e83900318723e487bab9cb4f67f4544182638325e30 |