नाम बदलें

POST https://api.pushwoosh.com/messaging/v2/rename

message_code द्वारा पहचाने गए, पहले से बनाए गए संदेश का अभियान नाम सेट या साफ़ करता है। संदेश के बारे में और कुछ नहीं बदलता। सामग्री, ऑडियंस और शेड्यूल बिल्कुल वैसे ही रहते हैं जैसे थे।

नाम बदलना केवल तभी उपलब्ध है जब संदेश अभी भी लंबित हो — बनाया गया है लेकिन अभी तक भेजने के लिए नहीं उठाया गया है। जो संदेश waiting, processing, या किसी भी बाद की स्थिति में जा चुका है, उसका नाम अब नहीं बदला जा सकता। Control Panel में यह स्थिति स्थिति कॉलम में शाब्दिक रूप से “Pending” के बजाय अनुसूचित के रूप में दिखाई देती है। देखें संदेश स्थितियां।

नाम को आगे और पीछे के रिक्त स्थान से ट्रिम किया जाता है और 255 वर्णों तक काटा जाता है। एक खाली (या केवल रिक्त स्थान वाला) नाम अभियान नाम को पूरी तरह से साफ़ कर देता है, और संदेश Message History में अपने डिफ़ॉल्ट शीर्षक पर वापस चला जाता है।
यह कॉल इडेम्पोटेंट है: वही नाम फिर से भेजने पर वही मान फिर से लागू होता है। यह हर कॉल पर संदेश के अंतिम-संशोधित समय को छूता है, चाहे नाम वास्तव में बदला हो या नहीं, इसलिए एक दोहराई गई कॉल संदेश को Message History के डिफ़ॉल्ट अंतिम संशोधित क्रम में सबसे ऊपर ले जा सकती है।

यह जांचने के लिए कि क्या कोई संदेश अभी भी नाम बदलने योग्य स्थिति में है, देखें संदेश स्थिति की जाँच करना।

अनुरोध

Authorization: Token <API_TOKEN> हेडर में अपने सर्वर एपीआई टोकन के साथ प्रमाणित करें।

फ़ील्ड	प्रकार	आवश्यक	विवरण
`message_code`	string	हाँ	नाम बदलने के लिए संदेश का संदेश कोड, जैसा कि `Notify` द्वारा `result.message_code` में लौटाया गया है।
`campaign_name`	string	हाँ	नया अभियान नाम। ट्रिम किया गया और 255 वर्णों तक काटा गया। एक खाली स्ट्रिंग नाम को साफ़ कर देती है।

उदाहरण अनुरोध

curl -X POST https://api.pushwoosh.com/messaging/v2/rename \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX",
    "campaign_name": "Flash_Sale_Push"
  }'

प्रतिक्रिया

सफलता पर, एक खाली JSON बॉडी के साथ HTTP 200 लौटाता है।

{}

त्रुटियाँ

त्रुटियाँ मानक gRPC-गेटवे त्रुटि लिफाफे का उपयोग करती हैं: { "code": ..., "message": ..., "details": [...] }।

HTTP स्थिति	शर्त
`400`	`message_code` गुम है।
`400`	संदेश नाम बदलने योग्य स्थिति में नहीं है (यह अब `pending` नहीं है)।
`403`	संदेश किसी अन्य खाते का है।
`404`	दिए गए `message_code` के लिए कोई संदेश मौजूद नहीं है।
`500`	संदेश लोड करते समय या नया नाम लागू करते समय एक आंतरिक त्रुटि हुई। अनुरोध को पुनः प्रयास करें।

उदाहरण

ऐसे संदेश का नाम बदलना जिसकी भेजने की प्रक्रिया पहले ही शुरू हो चुकी है, HTTP 400 लौटाता है:

{
  "code": 9,
  "message": "message status \"waiting\" is not renamable",
  "details": []
}

संदेश स्थिति की जाँच करना

नाम बदलने से पहले, आप यह सत्यापित कर सकते हैं कि कोई संदेश अभी भी नाम बदलने योग्य स्थिति में है या नहीं। Control Panel में संदेश तालिका में स्थिति कॉलम पढ़ने के अलावा (अभियान → एक-बार के संदेश), जहां नाम बदलने योग्य संदेश शाब्दिक रूप से “Pending” के बजाय अनुसूचित के रूप में दिखता है, आप messages:list के साथ प्रोग्रामेटिक रूप से स्थिति की पूछताछ कर सकते हैं:

filters.messages_codes ऐरे में message_code पास करें (आवश्यक filters.application के साथ)।
items[] में मेल खाने वाली प्रविष्टि के status फ़ील्ड को पढ़ें।